Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Flower Framework
Light Logo Dark Logo
v1.33.x

Tutorial

  • What is Federated Learning?
  • Get started with Flower
  • Write your first Flower App
  • Write your first Flower App with PyTorch
  • 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
    • Install Flower App dependencies at runtime
    • OpenFL Migration Guide
    • Upgrade to Flower 1.0
    • Upgrade to Flower 1.13
    • Upgrade to Message API
    • Upgrade to Flower 1.28
  • Simulate
    • Run Flower Locally with a Managed SuperLink
    • Run simulations
  • Deploy
    • Run Flower with the Deployment Runtime
    • 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
    • Create and Manage Federations on SuperGrid
    • Connect SuperNodes to SuperGrid
    • Run Flower Apps on SuperGrid

Explanations

  • Federated evaluation
  • Differential Privacy
  • Secure Aggregation Protocols
  • Flower Architecture
  • SuperLink High Availability Mode
  • Flower Strategy Abstraction

References

  • Reference
    • flwr
      • agentapp
        • AgentApp
        • AgentConnectors
        • AgentResponses
        • AgentSession
        • LoadAgentAppError
      • app
        • Array
        • ArrayRecord
        • ConfigRecord
        • Context
        • Error
        • Message
        • MessageType
        • Metadata
        • MetricRecord
        • RecordDict
      • 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
      • 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
        • ConfigRecord
        • ConfigsRecord
        • Context
        • DisconnectRes
        • Error
        • EvaluateIns
        • EvaluateRes
        • EventType
        • FitIns
        • FitRes
        • GetParametersIns
        • GetParametersRes
        • GetPropertiesIns
        • GetPropertiesRes
        • Message
        • MessageType
        • MessageTypeLegacy
        • Metadata
        • MetricRecord
        • MetricsRecord
        • Parameters
        • ParametersRecord
        • 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
    • Flower Configuration
    • Example projects
    • Telemetry
    • Changelog
    • Flower Runtime Comparison
    • Flower Network Communication
    • Exit Codes
      • [0] SUCCESS
      • [1] GRACEFUL_EXIT_SIGINT
      • [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
      • [250] CLIENTAPP_COMMUNICATION_ERROR
      • [3] GRACEFUL_EXIT_SIGTERM
      • [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
      • [401] SUPEREXEC_AUTH_SECRET_LOAD_FAILED
      • [402] SUPEREXEC_INVALID_EXECUTOR_CONFIG
      • [500] FLWRCLI_NODE_AUTH_PUBLIC_KEY_INVALID
      • [600] COMMON_ADDRESS_INVALID
      • [602] COMMON_TLS_NOT_SUPPORTED
      • [603] COMMON_TLS_ROOT_CERTIFICATES_INCOMPATIBLE
      • [604] COMMON_PATH_INVALID
      • [605] COMMON_TLS_SERVER_CERTIFICATES_INVALID
      • [606] RUNTIME_VERSION_INCOMPATIBLE
      • [607] COMMON_APP_IMPORT_ERROR
      • [608] COMMON_RUNTIME_DEPENDENCY_INSTALLATION_ERROR
      • [700] SIMULATION_EXCEPTION
      • [701] SIMULATION_MISSING_EXTRA
      • [800] TASK_PROC_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
🇬🇧 🇫🇷 🇨🇳 🇰🇷
Back to top
View this page

Changelog¶

Loading the changelog from main…

Next
Flower Runtime Comparison
Previous
Telemetry
Copyright © 2026 Flower Labs GmbH
Made with Sphinx and @pradyunsg's Furo