3.1. Quick Start (single experiment using terminal)

In this page, we will show how to start an experiment locally using the config fils in QucikStart dir. Please clone the project from Github, open a terminal from the project path and follow the next tutorial.

3.1.1. Generate the data and docker-compose file

Generate the data for all the clients

docker run -it --rm -v $(pwd):$(pwd) -w $(pwd) fedeval:v1 python -W ignore -m FedEval.run -c configs/quickstart -f data

Generate the docker-compose file

docker run -it --rm -v $(pwd):$(pwd) -w $(pwd) fedeval:v1 python -W ignore -m FedEval.run -c configs/quickstart -f compose-local

3.1.2. Start the Experiment

docker-compose up -d

3.1.3. View the results

Go to http://127.0.0.1:port/dashboard to see the results. Please change the port according to your config. More detail about the config could be found in Configs.

Here’s an example of the dashboard.

3.1.4. Stop the Experiment

Stop and remove the containers using docker-compose (suggested)

docker-compose stop
docker-compose rm

Force stop and remove all the containers

docker stop $(docker ps --filter ancestor=fedeval:v1 -aq)
docker rm $(docker ps --filter ancestor=fedeval:v1 -aq)

3.1.5. Dashboard Example

Dashboard Example