Skip to main content

Flower - A Friendly Federated Learning Framework

Project description

Flower - A Friendly Federated Learning Framework

GitHub license PRs Welcome Build Downloads Slack

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, PyTorch Lightning, MXNet, scikit-learn, TFLite, 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.

Meet the Flower community on flower.dev!

Documentation

Flower Docs:

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 / Datasets

Experimental - curious minds can take a peek at baselines.

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.18.0.dev20211014.tar.gz (120.4 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.18.0.dev20211014-py3-none-any.whl (234.8 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.18.0.dev20211014.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.18.0.dev20211014.tar.gz
  • Upload date:
  • Size: 120.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.10 CPython/3.7.9 Linux/5.8.0-1042-azure

File hashes

Hashes for flwr-nightly-0.18.0.dev20211014.tar.gz
Algorithm Hash digest
SHA256 c3644d46580fc818ba1ff9e78302cc56fd94f4a049f02089bb8ce1a5b4859b7b
MD5 20d8cb86f0d14ed16d05d15276dd7511
BLAKE2b-256 361c0c7452ace1942fa81f00889584cc20bcaccad2dccb2e86ad84bf8464abb0

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.18.0.dev20211014-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.18.0.dev20211014-py3-none-any.whl
Algorithm Hash digest
SHA256 e3ca6793d71ba1d8b2531b241552bb16aa7360057ad4438f830576adab29bb24
MD5 85a5b45580ea483bc99da31973baa9c0
BLAKE2b-256 3b068aec0d01753c2e93fc87e8258e4b305f8334a444ac465f1b6ee9e81332c5

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