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

Uploaded Source

Built Distribution

flwr_nightly-0.17.0.dev20210916-py3-none-any.whl (229.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flwr-nightly-0.17.0.dev20210916.tar.gz
  • Upload date:
  • Size: 117.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.7.9 Linux/5.8.0-1041-azure

File hashes

Hashes for flwr-nightly-0.17.0.dev20210916.tar.gz
Algorithm Hash digest
SHA256 9a98be9f48cc2eb11f1f3336a32589dede726d98413ee0e2ea45df1bea4fc276
MD5 c49b1b541d253b89576b320ae766430b
BLAKE2b-256 b2527e1a42cdf8790e2c8fc797c829d835922661627f0dfa6333544b8def5580

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flwr_nightly-0.17.0.dev20210916-py3-none-any.whl
Algorithm Hash digest
SHA256 d7cbfd601a66a69bf85c3f224aeca5126859df054b687165ccd8153e6afe316e
MD5 8adb3012845e3f45bbb1cec7d160c21d
BLAKE2b-256 5e7a5a03d1a80f4fd500eddbf19d31b62697ecbafe664c409fa807c8b02311f1

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