Skip to main content

Flower - A Friendly Federated Learning Research Framework

Project description

Flower (flwr) - A Friendly Federated Learning Framework

GitHub license PRs Welcome Build

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, 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.11.0.dev20201119.tar.gz (95.3 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.11.0.dev20201119-py3-none-any.whl (183.7 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.11.0.dev20201119.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.11.0.dev20201119.tar.gz
  • Upload date:
  • Size: 95.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1031-azure

File hashes

Hashes for flwr-nightly-0.11.0.dev20201119.tar.gz
Algorithm Hash digest
SHA256 ea68e1c83032f1c37f16cc760d1c3d57bd86dd5a96a631ce0a371c847a6671ba
MD5 4e7d14c3036ed795aa1653c594c21429
BLAKE2b-256 f66b6b8b9af4d2c146be04b06bf5c5a693d31572d9e4c237a69d322995f551a7

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.11.0.dev20201119-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.11.0.dev20201119-py3-none-any.whl
Algorithm Hash digest
SHA256 7fee845220e47a09b28316f6f2e1250b1b68c9cd293284c68b8728891770fa87
MD5 68405d2c2a329729fa93e3902d922ce8
BLAKE2b-256 3f7dcd838d32fe1e505c9c5ff0462d388ba7061fe67b165254ff3c2defe78a0f

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