Skip to main content

Flower - A Friendly Federated Learning Framework

Project description

Flower - A Friendly Federated Learning Framework

GitHub license PRs Welcome Build Downloads

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 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.13.0.dev20201217.tar.gz (98.3 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.13.0.dev20201217-py3-none-any.whl (199.3 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.13.0.dev20201217.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.13.0.dev20201217.tar.gz
  • Upload date:
  • Size: 98.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1032-azure

File hashes

Hashes for flwr-nightly-0.13.0.dev20201217.tar.gz
Algorithm Hash digest
SHA256 03de5a66cc837c6a91aa5dfe63be3446c96e69bd466763ce562f2750c1a52f1d
MD5 ea71faffe09c17c3a010a61aeb80d362
BLAKE2b-256 1bde2f87d280b590dcdb8fa7d4e2e6bfc4a0f375cc56f8185955dceeff099c33

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.13.0.dev20201217-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.13.0.dev20201217-py3-none-any.whl
Algorithm Hash digest
SHA256 36e9b4553e8a502ff886bcf5590b0b0ec4de1d8e0e67c775e8ba9f112063bbd7
MD5 710b79eb97650bd45eac66b82f3eecf6
BLAKE2b-256 f280267bcb13930e0372489fdbe8b9b933f248bffe351c4ba5635a51f0a47871

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