Skip to main content

Flower: A Friendly Federated Learning Framework

Project description

Flower: A Friendly Federated Learning Framework

Flower Website

Website | Blog | Docs | Conference | Slack

GitHub license PRs Welcome Build Downloads 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.

  1. What is Federated Learning?

    Open in Colab (or open the Jupyter Notebook)

  2. An Introduction to Federated Learning

    Open in Colab (or open the Jupyter Notebook)

  3. Using Strategies in Federated Learning

    Open in Colab (or open the Jupyter Notebook)

  4. Building Strategies for Federated Learning

    Open in Colab (or open the Jupyter Notebook)

  5. Custom Clients for Federated Learning

    Open in Colab (or open the Jupyter Notebook)

Stay tuned, more tutorials are coming soon. Topics include Privacy and Security in Federated Learning, and Scaling Federated Learning.

Documentation

Flower Docs:

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:

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:

Other examples:

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!

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flwr_nightly-1.5.0.dev20230519.tar.gz (92.2 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-1.5.0.dev20230519-py3-none-any.whl (167.8 kB view details)

Uploaded Python 3

File details

Details for the file flwr_nightly-1.5.0.dev20230519.tar.gz.

File metadata

  • Download URL: flwr_nightly-1.5.0.dev20230519.tar.gz
  • Upload date:
  • Size: 92.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.7.15 Linux/5.15.0-1037-azure

File hashes

Hashes for flwr_nightly-1.5.0.dev20230519.tar.gz
Algorithm Hash digest
SHA256 37fb6383b14102a1b7063a76ec384a0751fbda4bf2037ba8805206089b07282a
MD5 44c9db21da74d1b24e7f6473899dc2ad
BLAKE2b-256 64bceea47229a3a58970e0066c7238f053c3513dea9f7a48e5e6e0a4f2ded124

See more details on using hashes here.

File details

Details for the file flwr_nightly-1.5.0.dev20230519-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-1.5.0.dev20230519-py3-none-any.whl
Algorithm Hash digest
SHA256 c0ccd715f623b5b7ecea36814f7bac9cd1e0df118f102d9bf3349074421d5b54
MD5 5baa13a9d36f240ad6b825a48f75027b
BLAKE2b-256 365ab394225d24fe47d9fea7aad83ae8195d070d55a6f08c8c8cea7502574157

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page