Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
👉 Register now for Flower AI Summit 2025!
March 26-27, 🇬🇧 London & Online
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 MLX
    • Quickstart 🤗 Transformers
    • Quickstart JAX
    • Quickstart Pandas
    • Quickstart fastai
    • Quickstart PyTorch Lightning
    • Quickstart scikit-learn
    • Quickstart XGBoost
    • Quickstart Android
    • Quickstart iOS

How-to Guides

  • Build
    • Install Flower
    • Configure Clients
    • Design stateful ClientApps
    • Use strategies
    • Implement strategies
    • Aggregate evaluation results
    • Save and Load Model Checkpoints
    • Use Built-in Mods
    • Use Differential Privacy
    • Implement FedBN
    • Use CLI JSON output
    • Upgrade to Flower 1.0
    • Upgrade to Flower 1.13
  • Simulate
    • Run simulations
  • Deploy
    • Run Flower with the Deployment Engine
    • Enable TLS connections
    • Authenticate SuperNodes
    • Configure logging
    • Run Flower on Azure
    • Run Flower using Docker
      • Quickstart with Docker
      • Enable TLS for Secure Connections
      • Persist the State of the SuperLink
      • Set Environment Variables
      • Run with Root User Privileges
      • Run ServerApp or ClientApp as a Subprocess
      • Pin a Docker Image to a Specific Version
      • Use a Different Flower Version
      • Quickstart with Docker Compose
      • Run Flower Quickstart Examples with Docker Compose
      • Deploy Flower on Multiple Machines with Docker Compose

Explanations

  • Federated evaluation
  • Differential Privacy
  • Flower Architecture

References

  • Reference
    • flwr
      • client
        • start_client
        • start_numpy_client
        • Client
        • ClientApp
        • NumPyClient
        • mod
          • adaptiveclipping_mod
          • arrays_size_mod
          • fixedclipping_mod
          • make_ffn
          • message_size_mod
          • secagg_mod
          • secaggplus_mod
          • LocalDpMod
      • common
        • array_from_numpy
        • bytes_to_ndarray
        • configure
        • event
        • log
        • ndarray_to_bytes
        • ndarrays_to_parameters
        • now
        • parameters_to_ndarrays
        • Array
        • ArrayRecord
        • ClientMessage
        • Code
        • Config
        • ConfigRecord
        • ConfigsRecord
        • Context
        • DisconnectRes
        • Error
        • EvaluateIns
        • EvaluateRes
        • EventType
        • FitIns
        • FitRes
        • GetParametersIns
        • GetParametersRes
        • GetPropertiesIns
        • GetPropertiesRes
        • Message
        • MessageType
        • MessageTypeLegacy
        • Metadata
        • MetricRecord
        • Metrics
        • MetricsRecord
        • NDArray
        • NDArrays
        • Parameters
        • ParametersRecord
        • Properties
        • ReconnectIns
        • RecordDict
        • RecordSet
        • ServerMessage
        • Status
      • server
        • start_server
        • ClientManager
        • Driver
        • Grid
        • History
        • LegacyContext
        • Server
        • ServerApp
        • ServerAppComponents
        • ServerConfig
        • SimpleClientManager
        • strategy
          • Bulyan
          • DPFedAvgAdaptive
          • DPFedAvgFixed
          • DifferentialPrivacyClientSideAdaptiveClipping
          • DifferentialPrivacyClientSideFixedClipping
          • DifferentialPrivacyServerSideAdaptiveClipping
          • DifferentialPrivacyServerSideFixedClipping
          • FaultTolerantFedAvg
          • FedAdagrad
          • FedAdam
          • FedAvg
          • FedAvgAndroid
          • FedAvgM
          • FedMedian
          • FedOpt
          • FedProx
          • FedTrimmedAvg
          • FedXgbBagging
          • FedXgbCyclic
          • FedXgbNnAvg
          • FedYogi
          • Krum
          • QFedAvg
          • Strategy
        • workflow
          • DefaultWorkflow
          • SecAggPlusWorkflow
          • SecAggWorkflow
      • simulation
        • run_simulation
        • run_simulation_process
        • start_simulation
        • SimulationIoConnection
    • Flower CLI reference
    • Example projects
    • Telemetry
    • Changelog
    • Flower Network Communication
    • Exit Codes
      • [0] SUCCESS
      • [1] GRACEFUL_EXIT_SIGINT
      • [2] GRACEFUL_EXIT_SIGQUIT
      • [3] GRACEFUL_EXIT_SIGTERM
      • [100] SUPERLINK_THREAD_CRASH
      • [300] SUPERNODE_REST_ADDRESS_INVALID
      • [301] SUPERNODE_NODE_AUTH_KEYS_REQUIRED
      • [302] SUPERNODE_NODE_AUTH_KEYS_INVALID
      • [600] COMMON_ADDRESS_INVALID
      • [601] COMMON_MISSING_EXTRA_REST
      • [602] COMMON_TLS_NOT_SUPPORTED
    • FAQ

Contributor docs

  • Contribute
    • Contribute on GitHub
    • Get started as a contributor
    • 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
    • Public and private APIs
    • Good first contributions
    • Secure Aggregation Protocols
  • v1.8.0
  • v1.9.0
  • v1.10.0
  • v1.11.0
  • v1.11.1
  • v1.12.0
  • v1.13.0
  • v1.13.1
  • v1.14.0
  • v1.15.0
  • v1.15.1
  • v1.15.2
  • v1.16.0
  • v1.17.0
  • main
🇬🇧 🇫🇷 🇨🇳 🇰🇷
Back to top
View this page

Reference¶

References¶

Information-oriented API reference and other reference material.

flwr

Flower main package.
  • Flower CLI reference
    • Basic Commands
    • Advanced Commands
    • Technical Commands

Reference docs

  • Example projects
  • Telemetry
  • Changelog
  • Flower Network Communication
  • Exit Codes
  • FAQ
Next
flwr
Previous
Flower Architecture
Copyright © 2025 Flower Labs GmbH
Made with Sphinx and @pradyunsg's Furo
On this page
  • Reference
    • References