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 MXNet
  • 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
  • Upgrade to Flower 1.0

Legacy example guides

  • Example: Walk-Through PyTorch & MNIST
  • Example: PyTorch - From Centralized To Federated
  • Example: MXNet - Run MXNet Federated
  • Example: JAX - Run JAX Federated
  • Example: FedBN in PyTorch - From Centralized To Federated

Explanations

  • Federated evaluation
  • Differential privacy

API reference

  • flwr (Python API reference)
  • 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

Contributor explanations

  • Flower Architecture

Contributor references

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

FED Template#

Table of Contents#

  • Table of Contents

  • Summary

  • Motivation

    • Goals

    • Non-Goals

  • Proposal

  • Drawbacks

  • Alternatives Considered

  • Appendix

Summary#

[TODO - sentence 1: summary of the problem]

[TODO - sentence 2: summary of the solution]

Motivation#

[TODO]

Goals#

[TODO]

Non-Goals#

[TODO]

Proposal#

[TODO]

Drawbacks#

[TODO]

Alternatives Considered#

[Alternative 1]#

[TODO]

[Alternative 2]#

[TODO]

Appendix#

Next
Flower Enhancement Doc
Previous
FED - Flower Enhancement Doc
Copyright © 2022 Adap GmbH
Made with Sphinx and @pradyunsg's Furo
On this page
  • FED Template
    • Table of Contents
    • Summary
    • Motivation
      • Goals
      • Non-Goals
    • Proposal
    • Drawbacks
    • Alternatives Considered
      • [Alternative 1]
      • [Alternative 2]
    • Appendix