Skip to main content

Flower - A Friendly Federated Learning Framework

Project description

Flower - A Friendly Federated Learning Framework

Flower Website

Website | Blog | Docs | Conference | Slack

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, JAX, 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.19.0.dev20220323.tar.gz (61.9 kB view details)

Uploaded Source

Built Distribution

flwr_nightly-0.19.0.dev20220323-py3-none-any.whl (102.9 kB view details)

Uploaded Python 3

File details

Details for the file flwr-nightly-0.19.0.dev20220323.tar.gz.

File metadata

  • Download URL: flwr-nightly-0.19.0.dev20220323.tar.gz
  • Upload date:
  • Size: 61.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.7.12 Linux/5.11.0-1028-azure

File hashes

Hashes for flwr-nightly-0.19.0.dev20220323.tar.gz
Algorithm Hash digest
SHA256 ba577efa4f03efe8cf22f9c95ad041a5b579afcf2f1f450a403de11a3c12eeb5
MD5 8f8f0110f0f363c41aad336c7d49bd45
BLAKE2b-256 4f6888663ee44080bc0d2487086affd5a6bfa3d96073bc5fef752b216bd011b4

See more details on using hashes here.

File details

Details for the file flwr_nightly-0.19.0.dev20220323-py3-none-any.whl.

File metadata

File hashes

Hashes for flwr_nightly-0.19.0.dev20220323-py3-none-any.whl
Algorithm Hash digest
SHA256 ae0f931622c61dfefa3d37265d7799b842cfa1afd965f57c8790b982537ed48b
MD5 168ac684f37633f6db6511915a343b92
BLAKE2b-256 345fb7900e4d28aded0af0d35fe57491e93f9e66a133ada95d8c4e15e6b95e17

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