Skip to main content

Flower: A Friendly Federated AI Framework

Project description

Flower: A Friendly Federated AI Framework

Flower Website

Website | Blog | Docs | Slack

GitHub license PRs Welcome Build Downloads Docker Hub Slack

Flower (flwr) is a framework for building federated AI 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 University of Oxford, so it was built 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, scikit-learn, JAX, TFLite, MONAI, fastai, MLX, XGBoost, LeRobot for federated robots, Pandas for federated analytics, 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.ai!

Federated Learning Tutorial

Flower's goal is to make federated learning accessible to everyone. This series of tutorials introduces the fundamentals of federated learning and how to implement them in Flower.

  1. What is Federated Learning?

  2. Get started with Flower

  3. Write your first Flower App

  4. Write your first Flower App with PyTorch

  5. Use a federated learning strategy

  6. Customize a Flower Strategy

  7. Communicate Custom Messages

Stay tuned, more tutorials are coming soon. Topics include Privacy and Security in Federated Learning, and Scaling Federated Learning.

Documentation

Flower Docs:

Flower Baselines

Flower Baselines is a collection of community-contributed projects that reproduce the experiments performed in popular federated learning publications. Researchers can build on Flower Baselines to quickly evaluate new ideas. The Flower community loves contributions! Make your work more visible and enable others to build on it by contributing it as a baseline!

Please refer to the Flower Baselines Documentation for a detailed categorization of baselines and for additional info including:

Flower Usage Examples

Several code examples show different usage scenarios of Flower (in combination with popular machine learning frameworks such as PyTorch or TensorFlow).

Quickstart examples:

Other examples:

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 Fernandez-Marques, Javier and Gao, Yan and Sani, Lorenzo and Kwing, Hei Li and Parcollet, Titouan and Gusmão, Pedro PB de 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!

Project details


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-1.32.0.dev20260615.tar.gz (535.7 kB view details)

Uploaded Source

Built Distribution

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

flwr_nightly-1.32.0.dev20260615-py3-none-any.whl (942.4 kB view details)

Uploaded Python 3

File details

Details for the file flwr_nightly-1.32.0.dev20260615.tar.gz.

File metadata

  • Download URL: flwr_nightly-1.32.0.dev20260615.tar.gz
  • Upload date:
  • Size: 535.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for flwr_nightly-1.32.0.dev20260615.tar.gz
Algorithm Hash digest
SHA256 930ca79ddade0bab6ab03ad8b5234481e1326f79e19eb7821f00644dd8316e2f
MD5 eb0cfa57771b52a34bb3bed40d467f32
BLAKE2b-256 fbe78e943ec25b68b172c23394b123c5ff3833572d94dc7b65cf215614eb741b

See more details on using hashes here.

File details

Details for the file flwr_nightly-1.32.0.dev20260615-py3-none-any.whl.

File metadata

  • Download URL: flwr_nightly-1.32.0.dev20260615-py3-none-any.whl
  • Upload date:
  • Size: 942.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for flwr_nightly-1.32.0.dev20260615-py3-none-any.whl
Algorithm Hash digest
SHA256 cd9819ed3e23a14f9d6902ce92cedcc279aed4dae6a82d9c9b427bcfe363fc0c
MD5 f8a58005e9a644c38b7787167ab24cee
BLAKE2b-256 0b1db3f66829864ed32a1f586c4efdd2e03122512474ab9eb46d654e77479aff

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