diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 9c1b431a0..f6e17c8fd 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -117,32 +117,31 @@ Upload the package and seed model to FEDn controller using the APIClient: .. code:: python - client = APIClient(host=, secure=True, verify=True) + client = APIClient(host=, 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 ------------------------