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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: flwr-nightly-0.11.0.dev20201111.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.dev20201111.tar.gz
Algorithm Hash digest
SHA256 b41c397c037c1629a0f2504aecd425b8b90b19714606d47dc4b96844daaa97a4
MD5 ea83c0da198f3ee37a28563fe439c9ed
BLAKE2b-256 f68f77b7145211b4b30a733b1173be42ef2d0a109354273cbf73b89e434445ea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flwr_nightly-0.11.0.dev20201111-py3-none-any.whl
Algorithm Hash digest
SHA256 b7f94f9ed7ff05209c732b4b3350ea54c92071d304c42fb4e54f6611203d144b
MD5 7f69e5497998353f737df5d6831a428c
BLAKE2b-256 cb744fafc74d81d957c809d2186d09367ee891a6a5d379c3f184820058799c89

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