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

Uploaded Source

Built Distribution

flwr_nightly-0.17.0.dev20210903-py3-none-any.whl (228.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flwr-nightly-0.17.0.dev20210903.tar.gz
  • Upload date:
  • Size: 117.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.7.9 Linux/5.8.0-1040-azure

File hashes

Hashes for flwr-nightly-0.17.0.dev20210903.tar.gz
Algorithm Hash digest
SHA256 1ed9c9d217220d718cece6383db9f97a6dd96d981a1ea8ab626fb27b689f6d5c
MD5 624f8422f47f7e25a036a6f8b8ba0b4e
BLAKE2b-256 0ab08650e7a2ad33d27bd5c105d15671c14bc105e4830a5a840bd0635e2d4792

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flwr_nightly-0.17.0.dev20210903-py3-none-any.whl
Algorithm Hash digest
SHA256 fd7a5a0b035e6b878ede1156f4d6510116c3b467805c85eecf0cc37a564cf7fc
MD5 5462287d96fb4367ff6c2e54557a012d
BLAKE2b-256 17edcc24fa716c4294b74122dca3622d753b63d858b217ec346c3079c2cd1e84

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