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, Hugging Face Transformers, 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.dev20220104.tar.gz (59.3 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.18.0.dev20220104-py3-none-any.whl (100.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flwr-nightly-0.18.0.dev20220104.tar.gz
  • Upload date:
  • Size: 59.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.7.12 Linux/5.11.0-1022-azure

File hashes

Hashes for flwr-nightly-0.18.0.dev20220104.tar.gz
Algorithm Hash digest
SHA256 0ae6dd89718620a2f31b2f4228599699b317d540121f4841ad85300e7b04cd84
MD5 7d2ca31aa21422c7aec3da28f1f1d16d
BLAKE2b-256 5b3f396a55a2c0acbe8aadcae51751348da23a1c885d686dc1456d210e0b5f81

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flwr_nightly-0.18.0.dev20220104-py3-none-any.whl
Algorithm Hash digest
SHA256 60477bda53d81ffe6c9f116de7a51f3a93658e5be1ab50cb955b68b87ddf23b8
MD5 7d5354e2c64719794e4828dd93e1131a
BLAKE2b-256 a3506e2a166c95e55d572ccab342b73f679e3da5a38e7360c6a486d4c3f90c62

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