Skip to main content

Flower - A Friendly Federated Learning Research Framework

Project description

Flower (flwr) - A Friendly Federated Learning Research Framework

GitHub license PRs Welcome Build

Flower (flwr) is a research 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!

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.9.0.dev20201020.tar.gz (92.3 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.9.0.dev20201020-py3-none-any.whl (178.6 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.9.0.dev20201020.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.9.0.dev20201020.tar.gz
  • Upload date:
  • Size: 92.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.7.9 Linux/5.4.0-1026-azure

File hashes

Hashes for flwr-nightly-0.9.0.dev20201020.tar.gz
Algorithm Hash digest
SHA256 e7dda58eb301cf62e343000191f6f5499b0e594e2c7a973247f2d246885de9c9
MD5 32054cdbf8fde436d327d19d00404353
BLAKE2b-256 c44cf705dec7f2a9e99e99ddb6d85f11580d05c5f2319ea0dfb29b1e2cabe206

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.9.0.dev20201020-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.9.0.dev20201020-py3-none-any.whl
Algorithm Hash digest
SHA256 1c4420ba323d5e8a5b3a48f9cc7ed3000dcc12c1438e58adcea741371290fe62
MD5 b66a86efaa84fdd7f906e08e6804751f
BLAKE2b-256 ce8d8c1dd7acfce50ddb805704bc8af843d255ad9b40f006ace1df982fdca439

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