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.

Sign up for GitHub

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/update guide #579

Merged
merged 2 commits into from
Apr 16, 2024
Merged

Docs/update guide #579

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af851c0
We need to keep the flow of the guide intact. We began in pseudo-dist…
Apr 15, 2024
d19f8fe
Typo in the function call.
Apr 15, 2024
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
25 changes: 12 additions & 13 deletions docs/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,32 +117,31 @@ Upload the package and seed model to FEDn controller using the APIClient:

.. code:: python

client = APIClient(host=<controller-host, token=<access-token>, secure=True, verify=True)
client = APIClient(host=<controller-host>, token=<access-token>, secure=True, verify=True)

Configure and attach clients
----------------------------

**FEDn Studio**

In FEDn Studio, you can configure and attach clients to the network. Go to the 'Clients' tab and click 'Connect client'.
Download the client configuration file and save it to the root of the examples/mnist-pytorch folder. Rename the file to 'client.yaml'.
Then start the client by running the following command in the root of the project:
**Pseudo-distributed mode**

In pseudo-distributed mode, you can start a client using the provided docker compose template in the root of the project.
.. code-block::

export FEDN_AUTH_SCHEME=Bearer
fedn run client -in client.yaml --secure=True --force-ssl
docker-compose -f ../../docker-compose.yaml -f docker-compose.override.yaml up --scale client=2


**Pseudo-distributed mode**
This will build a container image for the client, start two clients and connect them to local API server.

In pseudo-distributed mode, you can start a client using the provided docker compose template in the root of the project.
.. code-block::
.. note::

docker-compose -f ../../docker-compose.yaml -f docker-compose.override.yaml up --scale client=2
In FEDn Studio, you can configure and attach clients to the network. Go to the 'Clients' tab and click 'Connect client'.
Download the client configuration file and save it to the root of the examples/mnist-pytorch folder. Rename the file to 'client.yaml'.
Then start the client by running the following command in the root of the project:

.. code-block::

This will build a container image for the client and start two clients.
export FEDN_AUTH_SCHEME=Bearer
fedn run client -in client.yaml --secure=True --force-ssl

Start a training session
------------------------
Expand Down
Loading