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.15.0.dev20210310.tar.gz (109.6 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.15.0.dev20210310-py3-none-any.whl (214.6 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.15.0.dev20210310.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.15.0.dev20210310.tar.gz
  • Upload date:
  • Size: 109.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1040-azure

File hashes

Hashes for flwr-nightly-0.15.0.dev20210310.tar.gz
Algorithm Hash digest
SHA256 ddbe8ad7618af504e5c4a3642c08e034ffa569ea1b00ac2a4bb2165016a4c8f1
MD5 00d6a84b56852f6ecc677fd349db55ed
BLAKE2b-256 d8858c7091ba259d671722184dc9813044b95f6f8a14eb2099956c7d1b7138d9

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.15.0.dev20210310-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.15.0.dev20210310-py3-none-any.whl
Algorithm Hash digest
SHA256 1e6c4fbb4a5c68991de5c77851b1f1a7ac8e0a7836bfad4cea314bc1cb657801
MD5 3f523f2cd28beaeaf706bfbf2e7be3d2
BLAKE2b-256 60f8b1e6fd0438dc15a7e76601eddd1dcbca1387510bab2af763938d73046c04

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