Skip to main content

Flower - A Friendly Federated Learning Research Framework

Project description

Flower (flwr) - A Friendly Federated Learning Framework

GitHub license PRs Welcome Build

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, 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.

Documentation

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

Available examples:

Flower Baselines

Coming soon - curious minds can take a peek at src/py/flwr_experimental/baseline.

Flower Datasets

Coming soon - curious minds can take a peek at src/py/flwr_experimental/baseline/dataset.

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!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flwr-0.10.0.tar.gz (96.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flwr-0.10.0-py3-none-any.whl (182.9 kB view details)

Uploaded Python 3

File details

Details for the file flwr-0.10.0.tar.gz.

File metadata

  • Download URL: flwr-0.10.0.tar.gz
  • Upload date:
  • Size: 96.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/4.4.0-19041-Microsoft

File hashes

Hashes for flwr-0.10.0.tar.gz
Algorithm Hash digest
SHA256 6da31f3e9db1d5560bd0963a3cbb337b340bc4a3e88b2b0f28ae5303e94de8f8
MD5 6e426a76546a98c01a43202eb8bd1611
BLAKE2b-256 f0a022dfa7bbe17dec24bf118fe62a96b610db0b15f1c1007047d7178e8a5932

See more details on using hashes here.

File details

Details for the file flwr-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: flwr-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 182.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/4.4.0-19041-Microsoft

File hashes

Hashes for flwr-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a60728e7c2f2c25365e35940b8f2ba5a747ba21770dfa1784d902f1f10f62aa
MD5 0ac4544c666784efa5554b26237a6c80
BLAKE2b-256 264b8d3a96311f5ae070732acbe58b037d5736fdcc3e5686a1c5579d5e6e3e87

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page