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 University of Oxford, so it was built 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, fastai, Pandas for federated analytics, 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!
Federated Learning Tutorial
Flower's goal is to make federated learning accessible to everyone. This series of tutorials introduces the fundamentals of federated learning and how to implement them in Flower.
-
An Introduction to Federated Learning
(or open the Jupyter Notebook)
-
Using Strategies in Federated Learning
-
Building Strategies for Federated Learning
-
Custom Clients for Federated Learning
Stay tuned, more tutorials are coming soon. Topics include Privacy and Security in Federated Learning, and Scaling Federated Learning.
Documentation
- Installation
- Quickstart (TensorFlow)
- Quickstart (PyTorch)
- Quickstart (Hugging Face [code example])
- Quickstart (PyTorch Lightning [code example])
- Quickstart (MXNet)
- Quickstart (Pandas)
- Quickstart (fastai)
- Quickstart (JAX)
- 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:
- FedAvg:
- FedProx:
- 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
Several code examples show different usage scenarios of Flower (in combination with popular machine learning frameworks such as PyTorch or TensorFlow).
Quickstart examples:
- Quickstart (TensorFlow)
- Quickstart (PyTorch)
- Quickstart (Hugging Face)
- Quickstart (PyTorch Lightning)
- Quickstart (fastai)
- Quickstart (Pandas)
- Quickstart (MXNet)
- Quickstart (JAX)
- 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
- Advanced Flower with TensorFlow/Keras
- Advanced Flower with PyTorch
- Single-Machine Simulation of Federated Learning Systems (PyTorch) (Tensorflow)
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 Fernandez-Marques, Javier and Gao, Yan and Sani, Lorenzo and Kwing, Hei Li and Parcollet, Titouan and Gusmão, Pedro PB de 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 1.4.0.dev20230314
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-1.4.0.dev20230314.tar.gz | 88.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flwr_nightly-1.4.0.dev20230314-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 244.4 kB
Release files / flwr_nightly-1.4.0.dev20230314.tar.gz
| Download URL | flwr_nightly-1.4.0.dev20230314.tar.gz |
|---|---|
| Size | 88.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
11951494011f8bd8f80818d73b43f6c7ec3b019ecf9304257c72d7d664239021
|
|
BLAKE2b-256 checksum How to use checksums |
273182ea7b2180ee324d09d756016797bf5e529bc74da1b045873cf078559587
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.7.15 Linux/5.15.0-1034-azure
|
Release files / flwr_nightly-1.4.0.dev20230314-py3-none-any.whl
| Download URL | flwr_nightly-1.4.0.dev20230314-py3-none-any.whl |
|---|---|
| Size | 155.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1ed09224ec8a5846732960c3d16869f54ca51e4f8ac0e290f9ccfb36b66d1f7e
|
|
BLAKE2b-256 checksum How to use checksums |
28262ac526972a72c474af836b40c4fecb2f4d4985039190a057e9b10e6aab9e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.7.15 Linux/5.15.0-1034-azure
|
