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 2026!
April 15-16, 🇬🇧 London
Flower Framework
Logo
Flower Framework v1.26.1

Tutorial

  • What is Federated Learning?
  • Get started with Flower
  • Use a federated learning strategy
  • Customize a Flower Strategy
  • Communicate custom Messages
  • 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 pyproject.toml
    • Configure a ClientApp
    • 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
    • OpenFL Migration Guide
    • Upgrade to Flower 1.0
    • Upgrade to Flower 1.13
    • Upgrade to Message API
  • Simulate
    • Run simulations
  • Deploy
    • Run Flower with the Deployment Engine
    • Enable TLS connections
    • Authenticate SuperNodes
    • Configure logging
    • Run Flower on GCP
    • Run Flower on Azure
    • Run Flower on Red Hat OpenShift
    • Run Flower on Multiple OpenShift Clusters
    • Authenticate Accounts via OpenID Connect
    • Configure Audit Logging
    • Manage Flower Federations
    • 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
    • Run Flower using Helm
      • Deploy SuperLink
      • Deploy SuperNode

Explanations

  • Federated evaluation
  • Differential Privacy
  • Secure Aggregation Protocols
  • Flower Architecture
  • Flower Strategy Abstraction

References

  • Reference
    • flwr
      • app
        • Array
        • ArrayRecord
        • ConfigRecord
        • Context
        • Error
        • Message
        • MessageType
        • Metadata
        • MetricRecord
        • RecordDict
        • UserConfig
      • clientapp
        • ClientApp
        • mod
          • adaptiveclipping_mod
          • arrays_size_mod
          • fixedclipping_mod
          • message_size_mod
          • LocalDpMod
      • serverapp
        • Grid
        • ServerApp
        • strategy
          • Bulyan
          • DifferentialPrivacyClientSideAdaptiveClipping
          • DifferentialPrivacyClientSideFixedClipping
          • DifferentialPrivacyServerSideAdaptiveClipping
          • DifferentialPrivacyServerSideFixedClipping
          • FedAdagrad
          • FedAdam
          • FedAvg
          • FedAvgM
          • FedMedian
          • FedProx
          • FedTrimmedAvg
          • FedXgbBagging
          • FedXgbCyclic
          • FedYogi
          • Krum
          • MultiKrum
          • QFedAvg
          • Result
          • Strategy
    • Flower CLI reference
    • Flower Configuration
    • Example projects
    • Telemetry
    • Changelog
    • Flower Runtime Comparison
    • Flower Network Communication
    • Exit Codes
      • [0] SUCCESS
      • [1] GRACEFUL_EXIT_SIGINT
      • [100] SUPERLINK_THREAD_CRASH
      • [101] SUPERLINK_LICENSE_INVALID
      • [102] SUPERLINK_LICENSE_MISSING
      • [103] SUPERLINK_LICENSE_URL_INVALID
      • [104] SUPERLINK_INVALID_ARGS
      • [105] SUPERLINK_DATABASE_SCHEMA_MISMATCH
      • [2] GRACEFUL_EXIT_SIGQUIT
      • [200] SERVERAPP_STRATEGY_PRECONDITION_UNMET
      • [201] SERVERAPP_EXCEPTION
      • [202] SERVERAPP_STRATEGY_AGGREGATION_ERROR
      • [203] SERVERAPP_RUN_START_REJECTED
      • [3] GRACEFUL_EXIT_SIGTERM
      • [300] SUPERNODE_REST_ADDRESS_INVALID
      • [302] SUPERNODE_NODE_AUTH_KEY_INVALID
      • [303] SUPERNODE_STARTED_WITHOUT_TLS_BUT_NODE_AUTH_ENABLED
      • [304] SUPERNODE_INVALID_TRUSTED_ENTITIES
      • [400] SUPEREXEC_INVALID_PLUGIN_CONFIG
      • [500] FLWRCLI_NODE_AUTH_PUBLIC_KEY_INVALID
      • [600] COMMON_ADDRESS_INVALID
      • [601] COMMON_MISSING_EXTRA_REST
      • [602] COMMON_TLS_NOT_SUPPORTED
      • [700] SIMULATION_EXCEPTION
    • 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
    • Migrate Flower Database Schema
    • Public and private APIs
    • Good first contributions
  • main
  • v1.26.1
  • v1.26.0
  • v1.25.0
  • v1.24.0
  • v1.23.0
  • v1.22.0
  • v1.21.0
  • v1.20.0
  • v1.19.0
  • v1.18.0
  • v1.17.0
  • v1.16.0
  • v1.15.2
  • v1.15.1
  • v1.15.0
  • v1.14.0
  • v1.13.1
  • v1.13.0
  • v1.12.0
  • v1.11.1
  • v1.11.0
  • v1.10.0
  • v1.9.0
  • v1.8.0
🇬🇧 🇫🇷 🇨🇳 🇰🇷
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

Reference docs

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