Skip to main content

Flower - A Friendly Federated Learning Research Framework

Project description

Flower (flwr) - A Friendly Federated Learning Research Framework

GitHub license PRs Welcome Build

Flower (flwr) is a research 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, 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.

Documentation

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

Available examples:

Flower Baselines

Coming soon - curious minds can take a peek at src/py/flwr_experimental/baseline.

Flower Datasets

Coming soon - curious minds can take a peek at src/py/flwr_experimental/baseline/dataset.

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.10.0.dev20201021.tar.gz (92.3 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.10.0.dev20201021-py3-none-any.whl (178.6 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.10.0.dev20201021.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.10.0.dev20201021.tar.gz
  • Upload date:
  • Size: 92.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.7.9 Linux/5.4.0-1031-azure

File hashes

Hashes for flwr-nightly-0.10.0.dev20201021.tar.gz
Algorithm Hash digest
SHA256 9578506f6f21ccb583505e5e26fbfaaf911ad4544224940aa5bada810259f582
MD5 d5882c7bdece1a01c8e4847b85e454c4
BLAKE2b-256 e68fa5c699056b7bd38dec6f6dbcbd1d88581805a4c8d4c2534fb78f33b799cf

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.10.0.dev20201021-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.10.0.dev20201021-py3-none-any.whl
Algorithm Hash digest
SHA256 a314cee28fe2597c1f77293dee1044df4c5b192e8b02df90623bd478d4e16f12
MD5 963bb9540977746ad050b84c78e9c5c6
BLAKE2b-256 d0eb7c4e07ff6b06aee10f69bf3cae736e0994fa7b2daa260598e24eca356f0e

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