Skip to main content

Flower - A Friendly Federated Learning Framework

Project description

Flower - A Friendly Federated Learning Framework

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, MXNet, scikit-learn, 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

Flower Docs:

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:

Flower Baselines / Datasets

Coming soon - curious minds can take a peek at baselines.

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.17.0.dev20210901.tar.gz (115.7 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.17.0.dev20210901-py3-none-any.whl (224.5 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.17.0.dev20210901.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.17.0.dev20210901.tar.gz
  • Upload date:
  • Size: 115.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.7.9 Linux/5.8.0-1039-azure

File hashes

Hashes for flwr-nightly-0.17.0.dev20210901.tar.gz
Algorithm Hash digest
SHA256 e85d9edb5d9191d9567071abd1c19c701f959d80f91a9fe2d8b4a65cd15d490f
MD5 e5b3f8fe6afcc60c9960d7f1b15f91da
BLAKE2b-256 480205b85c2e346cf9e394d4d61e58071bdd652bb1299fd3d8e50f959200ada6

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.17.0.dev20210901-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.17.0.dev20210901-py3-none-any.whl
Algorithm Hash digest
SHA256 13383bab40ef3b107cf5d3dff4ee35a087394f6f0c12deb2cbf49cd3022649c2
MD5 e83635c85285c139b196ceb1e91399aa
BLAKE2b-256 2fe18fcad53d99fb922b82da6ed07cb4ab691687456599a83f0f2961cc1b05e4

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