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, MXNet, scikit-learn, 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

Coming soon - 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.17.0.dev20210715.tar.gz (111.9 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.17.0.dev20210715-py3-none-any.whl (216.8 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.17.0.dev20210715.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.17.0.dev20210715.tar.gz
  • Upload date:
  • Size: 111.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.7.9 Linux/5.4.0-1051-azure

File hashes

Hashes for flwr-nightly-0.17.0.dev20210715.tar.gz
Algorithm Hash digest
SHA256 b795b40cc70266af75aa41c90510954c18826b0b23cb1dd26fc3cea6e6bcdc75
MD5 23600fc5074ba901927d2873832095f3
BLAKE2b-256 1357fe9060396ed40f2e5d5e82dc1c0287b289581eb81f9b765baeeae0d3c272

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.17.0.dev20210715-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.17.0.dev20210715-py3-none-any.whl
Algorithm Hash digest
SHA256 d350c650b5229ac37906b42902377df7f22724fbb6a6c3936f7e42d29b1f4f7a
MD5 e9360cf9e18380d9d42711568a31846d
BLAKE2b-256 34b9e2652b7f466731445b44c5d9b0c71a6bd808ae0fc5843c85cb76eb6069f2

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