This release is a pre-release and may not be stable for production use.
Flower - A Friendly Federated Learning Framework
Website |
Blog |
Docs |
Conference |
Slack
Flower (flwr) is a framework for building federated learning systems. The
design of Flower is based on a few guiding principles:
-
Customizable: Federated learning systems vary wildly from one use case to another. Flower allows for a wide range of different configurations depending on the needs of each individual use case.
-
Extendable: Flower originated from a research project at the Univerity of Oxford, so it was build with AI research in mind. Many components can be extended and overridden to build new state-of-the-art systems.
-
Framework-agnostic: Different machine learning frameworks have different strengths. Flower can be used with any machine learning framework, for example, PyTorch, TensorFlow, Hugging Face Transformers, PyTorch Lightning, MXNet, scikit-learn, JAX, TFLite, or even raw NumPy for users who enjoy computing gradients by hand.
-
Understandable: Flower is written with maintainability in mind. The community is encouraged to both read and contribute to the codebase.
Meet the Flower community on flower.dev!
Documentation
- Installation
- Quickstart (TensorFlow)
- Quickstart (PyTorch)
- Quickstart (Hugging Face [code example])
- Quickstart (PyTorch Lightning [code example])
- Quickstart (MXNet)
- Quickstart (JAX [code example])
- Quickstart (scikit-learn)
- Quickstart (TFLite on Android [code example])
Flower Baselines
Flower Baselines is a collection of community-contributed experiments that reproduce the experiments performed in popular federated learning publications. Researchers can build on Flower Baselines to quickly evaluate new ideas:
- FedBN: Federated Learning on non-IID Features via Local Batch Normalization:
- Adaptive Federated Optimization
Check the Flower documentation to learn more: Using Baselines
The Flower community loves contributions! Make your work more visible and enable others to build on it by contributing it as a baseline: Contributing Baselines
Flower Usage Examples
A number of examples show different usage scenarios of Flower (in combination with popular machine learning frameworks such as PyTorch or TensorFlow). To run an example, first install the necessary extras:
Quickstart examples:
- Quickstart (TensorFlow)
- Quickstart (PyTorch)
- Quickstart (Hugging Face)
- Quickstart (PyTorch Lightning)
- Quickstart (MXNet)
- Quickstart (scikit-learn)
- Quickstart (TFLite on Android)
Other examples:
- Raspberry Pi & Nvidia Jetson Tutorial
- Android & TFLite
- PyTorch: From Centralized to Federated
- MXNet: From Centralized to Federated
- JAX: From Centralized to Federated
- Advanced Flower with TensorFlow/Keras
- Single-Machine Simulation of Federated Learning Systems
Community
Flower is built by a wonderful community of researchers and engineers. Join Slack to meet them, contributions are welcome.
Citation
If you publish work that uses Flower, please cite Flower as follows:
@article{beutel2020flower,
title={Flower: A Friendly Federated Learning Research Framework},
author={Beutel, Daniel J and Topal, Taner and Mathur, Akhil and Qiu, Xinchi and Parcollet, Titouan and Lane, Nicholas D},
journal={arXiv preprint arXiv:2007.14390},
year={2020}
}
Please also consider adding your publication to the list of Flower-based publications in the docs, just open a Pull Request.
Contributing to Flower
We welcome contributions. Please see CONTRIBUTING.md to get started!
2 maintainers
Metadata
2 maintainers
Release files for flwr-nightly 0.19.0.dev20220326
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| flwr-nightly-0.19.0.dev20220326.tar.gz | 63.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flwr_nightly-0.19.0.dev20220326-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 168.3 kB
Release files / flwr-nightly-0.19.0.dev20220326.tar.gz
| Download URL | flwr-nightly-0.19.0.dev20220326.tar.gz |
|---|---|
| Size | 63.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
58a046e72dfd55fd5a40d960558072dc944d44b46418719d4537cac16a69bff8
|
|
BLAKE2b-256 checksum How to use checksums |
6b64afa222b9534f027511ff533e916b52f28d6d7dade7b3bc062a70fa328fb1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.7.12 Linux/5.11.0-1028-azure
|
Release files / flwr_nightly-0.19.0.dev20220326-py3-none-any.whl
| Download URL | flwr_nightly-0.19.0.dev20220326-py3-none-any.whl |
|---|---|
| Size | 105.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f2fd943a82860a2f9bc91bb8d7fe30663b3407b775119e2818498359d7219244
|
|
BLAKE2b-256 checksum How to use checksums |
437c43e1b284c9ad97012a60ed59d001fa63bfc9ff85bec4ff9028987bc3f354
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.7.12 Linux/5.11.0-1028-azure
|
