diff --git a/docs/aggregators.rst b/docs/aggregators.rst index 7878bcab5..bab17f045 100644 --- a/docs/aggregators.rst +++ b/docs/aggregators.rst @@ -116,4 +116,6 @@ This extension can then simply be called as such: .. meta:: :description lang=en: - Aggregators are responsible for combining client model updates into a combiner-level global model. During a training session, the combiners will instantiate an Aggregator and use it to process the incoming model updates from clients. \ No newline at end of file + Aggregators are responsible for combining client model updates into a combiner-level global model. During a training session, the combiners will instantiate an Aggregator and use it to process the incoming model updates from clients. + :robots: index, follow + :keywords: Federated Learning, Aggregators, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems diff --git a/docs/apiclient.rst b/docs/apiclient.rst index 7777187f8..4676bd375 100644 --- a/docs/apiclient.rst +++ b/docs/apiclient.rst @@ -137,4 +137,6 @@ For more information on how to use the APIClient, see the :py:mod:`fedn.network. .. meta:: :description lang=en: - FEDn comes with an APIClient - a Python3 library that can be used to interact with FEDn programmatically. In this tutorial we show how to use the APIClient to initialize the server-side with the compute package and seed models, run and control training sessions and to retrieve models and metrics. \ No newline at end of file + FEDn comes with an APIClient - a Python3 library that can be used to interact with FEDn programmatically. In this tutorial we show how to use the APIClient to initialize the server-side with the compute package and seed models, run and control training sessions and to retrieve models and metrics. + :keywords: Federated Learning, APIClient, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems + :robots: index, follow diff --git a/docs/architecture.rst b/docs/architecture.rst index af4549029..0060dbd05 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -54,4 +54,6 @@ many different possible outcomes can be achieved. Good starting configurations a .. meta:: :description lang=en: - Architecture overview - Constructing a federated model with FEDn amounts to a) specifying the details of the client-side training code and data integrations, and b) deploying the federated network. \ No newline at end of file + Architecture overview - Constructing a federated model with FEDn amounts to a) specifying the details of the client-side training code and data integrations, and b) deploying the federated network. + :keywords: Federated Learning, Architecture, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems + :robots: index, follow diff --git a/docs/auth.rst b/docs/auth.rst index 634866a99..e4222318b 100644 --- a/docs/auth.rst +++ b/docs/auth.rst @@ -103,4 +103,10 @@ For the client, you need to set the following environment variables: -You can use `--token` flags in the FEDn CLI to set the access token. \ No newline at end of file +You can use `--token` flags in the FEDn CLI to set the access token. + +.. meta:: + :description lang=en: + Authentication and Authorization (RBAC) - FEDn supports Role-Based Access Control (RBAC) for controlling access to the FEDn API and gRPC endpoints. The RBAC system is based on JSON Web Tokens (JWT) and is implemented using the `jwt` package. + :keywords: Federated Learning, Authentication and Authorization, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems + :robots: index, follow diff --git a/docs/developer.rst b/docs/developer.rst index 14d923605..36f418923 100644 --- a/docs/developer.rst +++ b/docs/developer.rst @@ -267,4 +267,6 @@ You can use `--token` flags in the FEDn CLI to set the access token. .. meta:: :description lang=en: - During development on FEDn, and when working on own extentions including aggregators and helpers, it is useful to have a local development setup of the core FEDn server-side services (controller, combiner etc). We provide Dockerfiles and docker-compose template for an all-in-one local sandbox \ No newline at end of file + During development on FEDn, and when working on own extentions including aggregators and helpers, it is useful to have a local development setup of the core FEDn server-side services (controller, combiner etc). We provide Dockerfiles and docker-compose template for an all-in-one local sandbox + :keywords: Federated Learning, Developer guide, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems + :robots: index, follow \ No newline at end of file diff --git a/docs/faq.rst b/docs/faq.rst index 3bbf6cccb..a9c651eb8 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -89,4 +89,6 @@ with the Scaleout team. .. meta:: :description lang=en: - How do you approach the question of output privacy? We take security in (federated) machine learning seriously. Federated learning is a foundational technology that improves input privacy in machine learning by allowing datasets to stay local and private, and not copied to a server. \ No newline at end of file + How do you approach the question of output privacy? We take security in (federated) machine learning seriously. Federated learning is a foundational technology that improves input privacy in machine learning by allowing datasets to stay local and private, and not copied to a server. + :keywords: Federated Learning, FAQ, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems + :robots: index, follow diff --git a/docs/fedn.network.api.rst b/docs/fedn.network.api.rst index 92f129711..9f3db0391 100644 --- a/docs/fedn.network.api.rst +++ b/docs/fedn.network.api.rst @@ -40,3 +40,6 @@ fedn.network.api.tests module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.clients.rst b/docs/fedn.network.clients.rst index 2983e9ec9..fe98e345f 100644 --- a/docs/fedn.network.clients.rst +++ b/docs/fedn.network.clients.rst @@ -48,3 +48,6 @@ fedn.network.clients.test\_client module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.combiner.aggregators.rst b/docs/fedn.network.combiner.aggregators.rst index afc4f66dd..2e399d491 100644 --- a/docs/fedn.network.combiner.aggregators.rst +++ b/docs/fedn.network.combiner.aggregators.rst @@ -40,3 +40,6 @@ fedn.network.combiner.aggregators.fedopt module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.combiner.rst b/docs/fedn.network.combiner.rst index e538665e9..bcd563825 100644 --- a/docs/fedn.network.combiner.rst +++ b/docs/fedn.network.combiner.rst @@ -64,3 +64,6 @@ fedn.network.combiner.roundhandler module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.controller.rst b/docs/fedn.network.controller.rst index c9d001794..84fdecf89 100644 --- a/docs/fedn.network.controller.rst +++ b/docs/fedn.network.controller.rst @@ -24,3 +24,6 @@ fedn.network.controller.controlbase module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.dashboard.rst b/docs/fedn.network.dashboard.rst deleted file mode 100644 index d64563ad7..000000000 --- a/docs/fedn.network.dashboard.rst +++ /dev/null @@ -1,18 +0,0 @@ -fedn.network.dashboard package -============================== - -.. automodule:: fedn.network.dashboard - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -fedn.network.dashboard.restservice module ------------------------------------------ - -.. automodule:: fedn.network.dashboard.restservice - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/fedn.network.loadbalancer.rst b/docs/fedn.network.loadbalancer.rst index 7934f2228..db88bc8be 100644 --- a/docs/fedn.network.loadbalancer.rst +++ b/docs/fedn.network.loadbalancer.rst @@ -32,3 +32,6 @@ fedn.network.loadbalancer.loadbalancerbase module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.rst b/docs/fedn.network.rst index 4de67418d..43311ea12 100644 --- a/docs/fedn.network.rst +++ b/docs/fedn.network.rst @@ -37,3 +37,6 @@ fedn.network.state module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.statestore.rst b/docs/fedn.network.statestore.rst index 06d2d4607..ce983a31d 100644 --- a/docs/fedn.network.statestore.rst +++ b/docs/fedn.network.statestore.rst @@ -24,3 +24,6 @@ fedn.network.statestore.statestorebase module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.storage.models.rst b/docs/fedn.network.storage.models.rst index 955ab2c14..e7450668f 100644 --- a/docs/fedn.network.storage.models.rst +++ b/docs/fedn.network.storage.models.rst @@ -32,3 +32,6 @@ fedn.network.storage.models.tempmodelstorage module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.storage.rst b/docs/fedn.network.storage.rst index bd256844b..5fb804959 100644 --- a/docs/fedn.network.storage.rst +++ b/docs/fedn.network.storage.rst @@ -15,3 +15,6 @@ Subpackages fedn.network.storage.models fedn.network.storage.s3 fedn.network.storage.statestore + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.storage.s3.rst b/docs/fedn.network.storage.s3.rst index f6e3b68f7..3def5cf1d 100644 --- a/docs/fedn.network.storage.s3.rst +++ b/docs/fedn.network.storage.s3.rst @@ -32,3 +32,6 @@ fedn.network.storage.s3.repository module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.network.storage.statestore.rst b/docs/fedn.network.storage.statestore.rst index 892b5a19a..16690c022 100644 --- a/docs/fedn.network.storage.statestore.rst +++ b/docs/fedn.network.storage.statestore.rst @@ -24,3 +24,6 @@ fedn.network.storage.statestore.statestorebase module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.rst b/docs/fedn.rst index 478dc18b6..2f6a9d2dd 100644 --- a/docs/fedn.rst +++ b/docs/fedn.rst @@ -14,3 +14,6 @@ Subpackages fedn.network fedn.utils + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.utils.helpers.plugins.rst b/docs/fedn.utils.helpers.plugins.rst index 9cf29c973..ff6abac29 100644 --- a/docs/fedn.utils.helpers.plugins.rst +++ b/docs/fedn.utils.helpers.plugins.rst @@ -16,3 +16,6 @@ fedn.utils.helpers.plugins.numpyhelper module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.utils.helpers.rst b/docs/fedn.utils.helpers.rst index db7adf4fd..46b540a71 100644 --- a/docs/fedn.utils.helpers.rst +++ b/docs/fedn.utils.helpers.rst @@ -32,3 +32,6 @@ fedn.utils.helpers.helpers module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.utils.plugins.rst b/docs/fedn.utils.plugins.rst index adc4ee88a..4629e0918 100644 --- a/docs/fedn.utils.plugins.rst +++ b/docs/fedn.utils.plugins.rst @@ -40,3 +40,6 @@ fedn.utils.plugins.pytorchhelper module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/fedn.utils.rst b/docs/fedn.utils.rst index 4e1fc4341..09073b4ec 100644 --- a/docs/fedn.utils.rst +++ b/docs/fedn.utils.rst @@ -40,3 +40,6 @@ fedn.utils.process module :members: :undoc-members: :show-inheritance: + +.. meta:: + :robots: index, follow \ No newline at end of file diff --git a/docs/helpers.rst b/docs/helpers.rst index 7a140687a..2a696aa14 100644 --- a/docs/helpers.rst +++ b/docs/helpers.rst @@ -30,4 +30,6 @@ for further details. .. meta:: :description lang=en: - Model marshalling - In federated learning, model updates need to be serialized and deserialized in order to be transferred between clients and server/combiner. There is also a need to write and load models to/from disk, for example to transiently store updates during training rounds. \ No newline at end of file + Model marshalling - In federated learning, model updates need to be serialized and deserialized in order to be transferred between clients and server/combiner. There is also a need to write and load models to/from disk, for example to transiently store updates during training rounds. + :keywords: Federated Learning, Model marshalling, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems + :robots: index, follow diff --git a/docs/index.rst b/docs/index.rst index d8f1c3541..5e1ab7ccf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,3 +29,9 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +.. meta:: + :description lang=en: + FEDn is a federated learning platform that is secure, scalable and easy-to-use. FEDn supports the full journey from early testing/exploration, through pilot projects, to real-world deployments and integration. + :keywords: Federated Learning, Machine Learning, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems + :robots: index, follow \ No newline at end of file diff --git a/docs/introduction.rst b/docs/introduction.rst index 101fb0d43..b57888285 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -78,4 +78,4 @@ For professionals / Enteprise, we offer `Dedicated support