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.

Community

Flower is built by a wonderful community of researchers and engineers. Join Slack to meet them, contributions are welcome.

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

Uploaded Source

Built Distribution

flwr_nightly-0.18.0.dev20220203-py3-none-any.whl (103.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flwr-nightly-0.18.0.dev20220203.tar.gz
Algorithm Hash digest
SHA256 551271a32359900053095b62689802a0525bd40a3d5fb65c3063d12a2e47ff38
MD5 b0d857da68bd5e58da542f90d24d1937
BLAKE2b-256 5bd12e650d3add5d4474f4c02f071556a39e97f58a5a03099ef1c10d3b363c9d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flwr_nightly-0.18.0.dev20220203-py3-none-any.whl
Algorithm Hash digest
SHA256 3bf537cfc8c61c3967db37c46096e29304641bde8fcd94aa6d18265f52cfc159
MD5 cf5f1fd016661a57d21c5ec0240a35d2
BLAKE2b-256 518f560535e52b84d7722c97f737ca961fb32387121045b56ec848e4e0bafe38

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