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

Quickstart examples:

Other 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.17.0.dev20210525.tar.gz (111.6 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.17.0.dev20210525-py3-none-any.whl (216.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flwr-nightly-0.17.0.dev20210525.tar.gz
  • Upload date:
  • Size: 111.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.7.9 Linux/5.4.0-1047-azure

File hashes

Hashes for flwr-nightly-0.17.0.dev20210525.tar.gz
Algorithm Hash digest
SHA256 e04ae86e95ca48c09e7051bc3f848caba7994e4f0527374b936c15c66951fbc5
MD5 d8af398b77458dc101ab24c42304b3f4
BLAKE2b-256 1561eb319d7af100ed403e6fc67f2b4743c32ccc5e34102c9a551f956a9a2cb0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flwr_nightly-0.17.0.dev20210525-py3-none-any.whl
Algorithm Hash digest
SHA256 e5167466960d884b4616a759c0a2bfa9401a0375e3af7f3c293e1375670bfae9
MD5 2e75de38d188bc02af9d55fb89b0bbda
BLAKE2b-256 80c902cc24a8d6f8655c7f404e24aa59bcf040ac042ba1664d83b1636a4269e0

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