Contents Menu Expand Light mode Dark mode Auto light/dark mode
Flower Framework
Logo
main

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 🤗 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
    • client
      • run_client_app
      • run_supernode
      • start_client
      • start_numpy_client
      • Client
      • ClientApp
      • NumPyClient
    • common
      • array_from_numpy
      • bytes_to_ndarray
      • configure
      • event
      • log
      • ndarray_to_bytes
      • now
      • ndarrays_to_parameters
      • parameters_to_ndarrays
      • Array
      • ClientMessage
      • Code
      • ConfigsRecord
      • Context
      • DisconnectRes
      • EvaluateIns
      • EvaluateRes
      • EventType
      • FitIns
      • FitRes
      • Error
      • GetParametersIns
      • GetParametersRes
      • GetPropertiesIns
      • GetPropertiesRes
      • Message
      • MessageType
      • MessageTypeLegacy
      • Metadata
      • MetricsRecord
      • Parameters
      • ParametersRecord
      • ReconnectIns
      • RecordSet
      • ServerMessage
      • Status
    • server
      • run_driver_api
      • run_fleet_api
      • run_server_app
      • run_superlink
      • start_driver
      • start_server
      • ClientManager
      • Driver
      • History
      • LegacyContext
      • Server
      • ServerApp
      • ServerConfig
      • SimpleClientManager
      • strategy
        • Bulyan
        • DPFedAvgAdaptive
        • DPFedAvgFixed
        • DifferentialPrivacyClientSideAdaptiveClipping
        • DifferentialPrivacyServerSideAdaptiveClipping
        • DifferentialPrivacyClientSideFixedClipping
        • DifferentialPrivacyServerSideFixedClipping
        • FedAdagrad
        • FedAdam
        • FedAvg
        • FedAvgAndroid
        • FedAvgM
        • FedMedian
        • FedOpt
        • FedProx
        • FedTrimmedAvg
        • FedXgbBagging
        • FedXgbCyclic
        • FedXgbNnAvg
        • FedYogi
        • FaultTolerantFedAvg
        • Krum
        • QFedAvg
        • Strategy
      • workflow
        • DefaultWorkflow
        • SecAggPlusWorkflow
        • SecAggWorkflow
    • simulation
      • start_simulation
      • run_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
  • Creating New Messages
  • Write documentation
  • Release Flower
  • Contribute translations
  • How to build Docker Flower images locally

Contributor explanations

  • Flower Architecture

Contributor references

  • FED - Flower Enhancement Doc
    • FED Template
    • Flower Enhancement Doc
  • Good first contributions
  • Secure Aggregation Protocols
  • v1.5.0
  • v1.6.0
  • v1.7.0
  • v1.8.0
  • main
🇬🇧 🇫🇷 🇨🇳
Back to top

flwr#

Flower main package.

Modules

flwr.client

Flower client.

flwr.common

Common components shared between server and client.

flwr.server

Flower server.

flwr.simulation

Flower simulation.
Next
client
Previous
Differential Privacy
Copyright © 2024 Flower Labs GmbH
Made with Sphinx and @pradyunsg's Furo