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.dev20201028.tar.gz (93.5 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.10.0.dev20201028-py3-none-any.whl (181.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flwr-nightly-0.10.0.dev20201028.tar.gz
  • Upload date:
  • Size: 93.5 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.dev20201028.tar.gz
Algorithm Hash digest
SHA256 ffb7298545b8df755329ed06ce94ca24780c2540275f7ebe2c9a26b0ee8452a7
MD5 b4ae3dedb6baf4fa4a3afea935e87cb3
BLAKE2b-256 7fa973fd3c23f03b6a39e1fe9441758978a535468ef45e327755d9cf298bed3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flwr_nightly-0.10.0.dev20201028-py3-none-any.whl
Algorithm Hash digest
SHA256 a04c000d20f8d59f5cbc969b0eb6c34d7655efe406cc63539861876f44086318
MD5 f29db4787d447457c213feb78f10fd44
BLAKE2b-256 2a4744ac2ac39f8923ff46033a67d7fd9ed6e97a03c23d189bac77e36063b6f2

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