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.4.0.dev20230331.tar.gz (89.5 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-1.4.0.dev20230331-py3-none-any.whl (158.7 kB view details)

Uploaded Python 3

File details

Details for the file flwr_nightly-1.4.0.dev20230331.tar.gz.

File metadata

  • Download URL: flwr_nightly-1.4.0.dev20230331.tar.gz
  • Upload date:
  • Size: 89.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.7.15 Linux/5.15.0-1034-azure

File hashes

Hashes for flwr_nightly-1.4.0.dev20230331.tar.gz
Algorithm Hash digest
SHA256 3e909134c8b753c68ddfae23676dceeba80e8770e1a72b58d80f86c940b04639
MD5 c0fe09b10a018c6491e1bdcbd2741179
BLAKE2b-256 7d90143c2d19e96410af2045e1f16473e678279eb183bb1469261067ee6c174a

See more details on using hashes here.

File details

Details for the file flwr_nightly-1.4.0.dev20230331-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-1.4.0.dev20230331-py3-none-any.whl
Algorithm Hash digest
SHA256 79fa0173242797d747acd0aa18cfbcbef1c18b0768b9ea5a71b90280dba30a37
MD5 5714ac9c3714a11a1497549537bce75b
BLAKE2b-256 a9e9622bc5eb7080bea3cb949c5c1d460558c8ad7f13be75ccf36c0b629ac505

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