Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

Flower Framework

Toggle table of contents sidebar

Tutorial

What is Federated Learning?
Get started with Flower
Use a federated learning strategy
Build a strategy from scratch
Customize the client

Quickstart tutorials

Quickstart PyTorch
Quickstart TensorFlow
Quickstart MLX
Quickstart 🤗 Transformers
Quickstart JAX
Quickstart Pandas
Quickstart fastai
Quickstart PyTorch Lightning
Quickstart scikit-learn
Quickstart XGBoost
Quickstart Android
Quickstart iOS

How-to guides

Install Flower
Configure clients
Use strategies
Implement strategies
Aggregate evaluation results
Save and load model checkpoints
Run simulations
Monitor simulation
Configure logging
Enable SSL connections
Use Built-in Mods
Use Differential Privacy
Authenticate SuperNodes
Run Flower using Docker
Upgrade to Flower 1.0
Upgrade to Flower Next

Legacy example guides

Example: PyTorch - From Centralized To Federated
Example: JAX - Run JAX Federated
Example: FedBN in PyTorch - From Centralized To Federated

Explanations

Federated evaluation
Differential Privacy

API reference

flwr
Toggle navigation of flwr
- client
  Toggle navigation of client
  - run_client_app
  - run_supernode
  - start_client
  - start_numpy_client
  - Client
  - ClientApp
  - NumPyClient
  - mod
    Toggle navigation of mod
- common
  Toggle navigation of common
- server
  Toggle navigation of server
  - run_server_app
  - run_superlink
  - start_server
  - ClientManager
  - Driver
  - History
  - LegacyContext
  - Server
  - ServerApp
  - ServerAppComponents
  - ServerConfig
  - SimpleClientManager
  - strategy
    Toggle navigation of strategy
  - workflow
    Toggle navigation of workflow
- simulation
  Toggle navigation of simulation
  - run_simulation
  - start_simulation

Flower CLI reference

Reference docs

Example projects
Telemetry
Changelog
FAQ

Contributor tutorials

Contribute on GitHub
Get started as a contributor

Contributor how-to guides

Install development versions
Set up a virtual env
Develop in VSCode Dev Containers
Write documentation
Release Flower
Contribute translations
How to build Docker Flower images locally

Contributor explanations

Flower Architecture
Public and private APIs

Contributor references

FED - Flower Enhancement Doc
Toggle navigation of FED - Flower Enhancement Doc
- FED Template
- Flower Enhancement Doc
Good first contributions
Secure Aggregation Protocols

Versions

v1.8.0
v1.9.0
v1.10.0
main

🇬🇧 🇫🇷 🇨🇳 🇰🇷

Toggle table of contents sidebar

run_driver_api#

Copyright © 2024 Flower Labs GmbH

Made with Sphinx and @pradyunsg's Furo