Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/SK-1084 | Improve SEO #716

Merged
merged 1 commit into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/aggregators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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
4 changes: 3 additions & 1 deletion docs/apiclient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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
4 changes: 3 additions & 1 deletion docs/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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
8 changes: 7 additions & 1 deletion docs/auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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
4 changes: 3 additions & 1 deletion docs/developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
4 changes: 3 additions & 1 deletion docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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
3 changes: 3 additions & 0 deletions docs/fedn.network.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ fedn.network.api.tests module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.clients.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,6 @@ fedn.network.clients.test\_client module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.combiner.aggregators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ fedn.network.combiner.aggregators.fedopt module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.combiner.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,6 @@ fedn.network.combiner.roundhandler module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@ fedn.network.controller.controlbase module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
18 changes: 0 additions & 18 deletions docs/fedn.network.dashboard.rst

This file was deleted.

3 changes: 3 additions & 0 deletions docs/fedn.network.loadbalancer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@ fedn.network.loadbalancer.loadbalancerbase module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ fedn.network.state module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.statestore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@ fedn.network.statestore.statestorebase module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.storage.models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@ fedn.network.storage.models.tempmodelstorage module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ Subpackages
fedn.network.storage.models
fedn.network.storage.s3
fedn.network.storage.statestore

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.storage.s3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@ fedn.network.storage.s3.repository module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.network.storage.statestore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@ fedn.network.storage.statestore.statestorebase module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ Subpackages

fedn.network
fedn.utils

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.utils.helpers.plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@ fedn.utils.helpers.plugins.numpyhelper module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.utils.helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@ fedn.utils.helpers.helpers module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.utils.plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ fedn.utils.plugins.pytorchhelper module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
3 changes: 3 additions & 0 deletions docs/fedn.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ fedn.utils.process module
:members:
:undoc-members:
:show-inheritance:

.. meta::
:robots: index, follow
4 changes: 3 additions & 1 deletion docs/helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ For professionals / Enteprise, we offer `Dedicated support <https://www.scaleout
:og:description: Federated Learning is a novel approach to address challenges related to data privacy, security, and decentralized data distribution.
:og:image: https://fedn.scaleoutsystems.com/static/images/scaleout_black.png
:og:url: https://fedn.scaleoutsystems.com/docs/introduction.html
:og:type: article
:og:type: website
6 changes: 6 additions & 0 deletions docs/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ API reference
:maxdepth: 4

fedn

.. meta::
:description lang=en:
API reference for FEDn, 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, API reference, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
:robots: index, follow
4 changes: 3 additions & 1 deletion docs/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -439,4 +439,6 @@ and its integration with popular machine learning frameworks like PyTorch and Te

.. meta::
:description lang=en:
A FEDn project is a convention for packaging/wrapping machine learning code to be used for federated learning with FEDn. At the core, a project is a directory of files, containing your machine learning code, FEDn entry points, and a specification of the runtime environment for the client.
A FEDn project is a convention for packaging/wrapping machine learning code to be used for federated learning with FEDn. At the core, a project is a directory of files, containing your machine learning code, FEDn entry points, and a specification of the runtime environment for the client.
:keywords: Federated Learning, Machine Learning, Federated Learning Framework, Federated Learning Platform, FEDn, Scaleout Systems
:robots: index, follow
Loading