Skip to content

Commit

Permalink
readme fix
Browse files Browse the repository at this point in the history
  • Loading branch information
viktorvaladi committed Mar 26, 2024
1 parent 1e978b6 commit e4df154
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions examples/flower-client/README.rst
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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:

Expand All @@ -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

0 comments on commit e4df154

Please sign in to comment.