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, Hugging Face Transformers, PyTorch Lightning, MXNet, scikit-learn, TFLite, 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

Experimental - curious minds can take a peek at baselines.

Community

Flower is built by a wonderful community of researchers and engineers. Join Slack to meet them, contributions are welcome.

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.18.0.dev20220125.tar.gz (61.4 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.18.0.dev20220125-py3-none-any.whl (103.4 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.18.0.dev20220125.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.18.0.dev20220125.tar.gz
  • Upload date:
  • Size: 61.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.7.12 Linux/5.11.0-1027-azure

File hashes

Hashes for flwr-nightly-0.18.0.dev20220125.tar.gz
Algorithm Hash digest
SHA256 d1e1935d4286d8de220842127192d40d4583235c81432c19a9e622ff9791b495
MD5 1b5d9b5707c51088771816c4563d6690
BLAKE2b-256 60c25bd0b5df5d6dc2aec7725dd6a3227da48e2fc9677aa3b23b293b8395ee61

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.18.0.dev20220125-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.18.0.dev20220125-py3-none-any.whl
Algorithm Hash digest
SHA256 1f32cf555b40f3093de27f94e633917e268595cb44b6bdbbee83536c426475b1
MD5 b8fb45208680920e367c8bd1b730ac94
BLAKE2b-256 a6c91f0a4cd834ae0eeea62e16acf7788912c4affb3b3277e1f5a7eb313b7138

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