Run Flower Quickstart Examples with Docker Compose¶
Flower provides a set of quickstart examples to help you get started with the framework. These examples are designed to demonstrate the capabilities of Flower and by default run using the Simulation Engine. This guide demonstrates how to run them using Flower's Deployment Engine via Docker Compose.
Important
Some quickstart examples may have limitations or requirements that prevent them from running on every environment. For more information, please see Limitations.
先决条件¶
Before you start, make sure that:
Run the Quickstart Example¶
Clone the quickstart example you like to run. For example,
quickstart-pytorch
:$ git clone --depth=1 https://github.com/adap/flower.git \ && mv flower/examples/quickstart-pytorch . \ && rm -rf flower && cd quickstart-pytorch
Download the compose.yml file into the example directory:
$ curl https://raw.githubusercontent.com/adap/flower/refs/tags/v1.13.0/src/docker/complete/compose.yml \ -o compose.yml
Export the version of Flower that your environment uses. Then, build and start the services using the following command:
$ export FLWR_VERSION="1.13.0" # update with your version $ docker compose up --build -d
Append the following lines to the end of the
pyproject.toml
file and save it:[tool.flwr.federations.local-deployment] address = "127.0.0.1:9093" insecure = true
Note
You can customize the string that follows
tool.flwr.federations.
to fit your needs. However, please note that the string cannot contain a dot (.
).In this example,
local-deployment
has been used. Just remember to replacelocal-deployment
with your chosen name in both thetool.flwr.federations.
string and the correspondingflwr run .
command.Run the example and follow the logs of the
ServerApp
:$ flwr run . local-deployment --stream
That is all it takes! You can monitor the progress of the run through the logs of the
ServerApp
.
Run a Different Quickstart Example¶
To run a different quickstart example, such as quickstart-tensorflow
, first, shut
down the Docker Compose services of the current example:
$ docker compose down
After that, you can repeat the steps above.
Limitations¶
Quickstart Example |
Limitations |
---|---|
quickstart-fastai |
无 |
quickstart-huggingface |
无 |
quickstart-jax |
无 |
quickstart-mlcube |
The example has not yet been updated to work with the latest |
quickstart-mlx |
|
quickstart-monai |
无 |
quickstart-pandas |
无 |
quickstart-pytorch-lightning |
Requires an older pip version that is not supported by the Flower Docker images. |
quickstart-pytorch |
无 |
quickstart-sklearn-tabular |
无 |
quickstart-tabnet |
The example has not yet been updated to work with the latest |
quickstart-tensorflow |
无 |