diff --git a/README.md b/README.md index 2c46cecfc818e3490a03da3f8c9870a8a25a2dbf..ce1e2ee594d858cafe21556b96b26a4479fb83da 100644 --- a/README.md +++ b/README.md @@ -49,8 +49,41 @@ cd Run ## Usage -### FL framework -FL scripts (includes server and client scripts) can be updated, example in dir `Flower_v1`. +### FL Framework + +FL scripts (including server and client scripts) can be updated, for example, in the `Flower_v1` directory. + +#### Important Notes on Flower Client Configuration + +When using this framework for Flower deployment on distributed servers, the client script should not require manual input of the `IP:PORT` for the Flower server. The framework is already designed to handle this automatically. + +##### Key Points: +- The Flower client must be started with the correct `server_address`, which is automatically configured in the framework. +- Users should **not manually input** the `IP:PORT` in configuration file, as the framework already passes this information automatically. +- The client script must be structured to accept the server address as an argument, ensuring compatibility with the framework. + +Example: + ```python + # Clients usage: python3 client.py <other_args> <IP:PORT>" + fl.client.start_client(server_address=sys.argv[<last_position>]) + ``` +So, in Configuration file will not including the IP:PORT of server in client cmd: + ```json + "clients": [ + { + "name": "client1", + "command": "python3", + "args": [ + "./Flower_v1/client_1.py", + "cifar10", + "0", + "3" + ], + "ip": "172.16.66.77" + },] + ``` +By following this structure, the deployment will function as expected without requiring manual intervention for the server address configuration. +``` ### Configure instance for CPU Configure instances of experiment in a json format, structure is shown below. @@ -262,6 +295,9 @@ After the experiment, exit the host and kill job if needed: oardel <job_id> ``` +### Results analysis +The 1st version of results analysis can be found in this repo [https://gitlab.irit.fr/sepia-pub/delight/fedeator_results_analysis](https://gitlab.irit.fr/sepia-pub/delight/fedeator_results_analysis) + ## License This project is licensed under [GPLv3]. \ No newline at end of file