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 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!

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. An Introduction to Federated Learning

    Open In Colab (or open the Jupyter Notebook)

  2. Using Strategies in Federated Learning

    Open In Colab (or open the Jupyter Notebook)

  3. Building Strategies for Federated Learning

    --- coming soon ---

  4. Privacy and Security in Federated Learning

    --- coming soon ---

  5. Scaling Federated Learning

    --- coming soon ---

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

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:

Usage Examples Documentation

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 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!

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-0.19.0.dev20220413.tar.gz (64.1 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.19.0.dev20220413-py3-none-any.whl (105.5 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.19.0.dev20220413.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.19.0.dev20220413.tar.gz
  • Upload date:
  • Size: 64.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.7.12 Linux/5.13.0-1021-azure

File hashes

Hashes for flwr-nightly-0.19.0.dev20220413.tar.gz
Algorithm Hash digest
SHA256 4aab62a5d3894cca669babec43cbaf81694cfc18a0f7b47ac7f63091496b3a7b
MD5 c47d4b4d93b9c21968afd237826e2b62
BLAKE2b-256 1c074784c2f34e370d41d33146052fc424e66332beeb8a79febd01eddf5f46c9

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.19.0.dev20220413-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.19.0.dev20220413-py3-none-any.whl
Algorithm Hash digest
SHA256 cdd019a7b72a1dad7962686d5bf39abba36d95dc6c14116d78fcad26326b3a30
MD5 a8e0020a7613719941d7474b5888fdaf
BLAKE2b-256 ee4461f09573a8b613e6e7d2185ae2800ed91cc08c290995460d0003fc6c0a4c

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