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!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flwr-0.9.0.tar.gz (92.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flwr-0.9.0-py3-none-any.whl (178.4 kB view details)

Uploaded Python 3

File details

Details for the file flwr-0.9.0.tar.gz.

File metadata

  • Download URL: flwr-0.9.0.tar.gz
  • Upload date:
  • Size: 92.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.7.9 Linux/4.19.104-microsoft-standard

File hashes

Hashes for flwr-0.9.0.tar.gz
Algorithm Hash digest
SHA256 ea6dc8e1dd1625bd12dda8e7ee8b8e2a7126d903a6961a14ccc016ef0219d06c
MD5 9a7a424d92658c8d26f67c7789045774
BLAKE2b-256 dd414d9f677b4ee7cabd72dbf096018614b6978d9c061c7392f456638bfcf57c

See more details on using hashes here.

File details

Details for the file flwr-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: flwr-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 178.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.7.9 Linux/4.19.104-microsoft-standard

File hashes

Hashes for flwr-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5f0e12be38df8f416b057490e53dd835563e1485b9ea6a4627620520df62724
MD5 405de2b49bfd15b47ecee9423d21ab23
BLAKE2b-256 e543e4e2b2063c8c428e5208d3c672aaad71239e348ee204e6231806b971816c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page