From e4df1549359dfe706979f30def6ad2a83486ebc4 Mon Sep 17 00:00:00 2001 From: viktorvaladi Date: Tue, 26 Mar 2024 12:52:40 +0100 Subject: [PATCH] readme fix --- examples/flower-client/README.rst | 40 +++++++++++++++---------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/examples/flower-client/README.rst b/examples/flower-client/README.rst index 4157c4eac..4deb1788b 100644 --- a/examples/flower-client/README.rst +++ b/examples/flower-client/README.rst @@ -1,14 +1,14 @@ Using Flower clients in FEDn -------------- +============================ This example shows how to run a Flower 'ClientApp' using the FEDn server-side infrastructure. See `flwr_client.py` and `flwr_task.py` for the Flower client code. The FEDn compute package is complemented with an adapter for the Flower client, `client_app_adapter.py`. - + Running the example ------------ +------------------- See `https://fedn.readthedocs.io/en/stable/quickstart.html` for a general introduction to FEDn. This example follows the same structure as the pytorch quickstart example. To build the compute package and seed model: @@ -30,8 +30,24 @@ Build a docker image containing the project dependencies including flower (this In a separate terminal, navigate to this folder, then start a client and inject the `CLIENT_NUMBER` dependency, for example for client1: + +If you are using a FEDn Studio project: +--------------------------------------- + +- Register a client in Studio and obtain the corresponding 'client.yaml' + +Then start the client: + +.. code-block:: + + docker run \ + -v $PWD/client.yaml:/app/client.yaml \ + -e CLIENT_NUMBER=0 \ + flower-client run client -in client.yaml --secure=True --force-ssl + + If you are running FEDn locally using the provided docker-compose template: -===== +--------------------------------------------------------------------------- Use the FEDn API Client to initalize FEDn with the compute package and seed model: @@ -56,19 +72,3 @@ The start the client --network=fedn_default \ -e CLIENT_NUMBER=0 \ flower-client run client -in client.yaml --name client1 - - -If you are using a FEDn Studio project: -===== - -- Register a client in Studio and obtain the corresponding 'client.yaml' - -Then start the client: - -.. code-block:: - - docker run \ - -v $PWD/client.yaml:/app/client.yaml \ - -e CLIENT_NUMBER=0 \ - flower-client run client -in client.yaml --secure=True --force-ssl -