Flower Examples Documentation
-----------------------------

Welcome to Flower Examples' documentation. `Flower <https://flower.ai>`_ is
a friendly federated learning framework.

Join the Flower Community
-------------------------

The Flower Community is growing quickly - we're a friendly group of researchers,
engineers, students, professionals, academics, and other enthusiasts.

.. button-link:: https://flower.ai/join-slack
    :color: primary
    :shadow:

    Join us on Slack

Quickstart Examples
-------------------

Flower Quickstart Examples are a collection of demo projects that show how you
can use Flower in combination with other existing frameworks or technologies.


.. list-table::
   :widths: 50 15 15 15
   :header-rows: 1

   * - Title
     - Framework
     - Dataset
     - Tags

   * - `Flower Clients in C++ (under development) <quickstart-cpp.html>`_ 
     - `C++ <https://isocpp.org/>`_ 
     - Synthetic 
     - quickstart, linear regression, tabular

   * - `Federated Learning with fastai and Flower (Quickstart Example) <quickstart-fastai.html>`_ 
     - `fastai <https://fast.ai/>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - quickstart, vision

   * - `Federated Learning with HuggingFace Transformers and Flower (Quickstart Example) <quickstart-huggingface.html>`_ 
     - `transformers <https://huggingface.co/docs/transformers/index>`_ 
     - `IMDB <https://huggingface.co/datasets/stanfordnlp/imdb>`_ 
     - quickstart, llm, nlp, sentiment

   * - `Federated Learning with JAX and Flower (Quickstart Example) <quickstart-jax.html>`_ 
     - `JAX <https://jax.readthedocs.io/en/latest/>`_, FLAX 
     - Synthetic 
     - quickstart, linear regression

   * - `Flower Example using TensorFlow/Keras + MLCube <quickstart-mlcube.html>`_ 
     - `mlcube <https://docs.mlcommons.org/mlcube/>`_, `tensorflow <https://www.tensorflow.org/>`_, `Keras <https://keras.io/>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - quickstart, vision, deployment

   * - `Federated Learning with MLX and Flower (Quickstart Example) <quickstart-mlx.html>`_ 
     - `MLX <https://ml-explore.github.io/mlx/build/html/index.html>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - quickstart, vision

   * - `Federated Learning with MONAI and Flower (Quickstart Example) <quickstart-monai.html>`_ 
     - `MONAI <https://monai.io/>`_ 
     - `MedNIST <https://medmnist.com/>`_ 
     - quickstart, medical, vision

   * - `Federated Learning with Pandas and Flower (Quickstart Example) <quickstart-pandas.html>`_ 
     - `pandas <https://pandas.pydata.org/>`_ 
     - `Iris <https://scikit-learn.org/stable/auto_examples/datasets/plot_iris_dataset.html>`_ 
     - quickstart, tabular, federated analytics

   * - `Federated Learning with PyTorch and Flower (Quickstart Example) <quickstart-pytorch.html>`_ 
     - `torch <https://pytorch.org/>`_, `torchvision <https://pytorch.org/vision/stable/index.html>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - quickstart, vision, fds

   * - `Federated Learning with PyTorch Lightning and Flower (Quickstart Example) <quickstart-pytorch-lightning.html>`_ 
     - `lightning <https://lightning.ai/docs/pytorch/stable/>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - quickstart, vision, fds

   * - `Federated Learning with scikit-learn and Flower (Quickstart Example) <quickstart-sklearn-tabular.html>`_ 
     - `scikit-learn <https://scikit-learn.org/>`_ 
     - `Iris <https://scikit-learn.org/stable/auto_examples/datasets/plot_iris_dataset.html>`_ 
     - quickstart, tabular, fds

   * - `Flower TabNet Example using TensorFlow <quickstart-tabnet.html>`_ 
     - `tabnet <https://github.com/titu1994/tf-TabNet>`_ 
     - `Iris <https://scikit-learn.org/stable/auto_examples/datasets/plot_iris_dataset.html>`_ 
     - quickstart, tabular

   * - `Federated Learning with Tensorflow/Keras and Flower (Quickstart Example) <quickstart-tensorflow.html>`_ 
     - `tensorflow <https://www.tensorflow.org/>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - quickstart, vision, fds

   * - `Federated Learning with XGBoost and Flower (Quickstart Example) <xgboost-quickstart.html>`_ 
     - `xgboost <https://xgboost.readthedocs.io/en/stable/>`_ 
     - `HIGGS <https://archive.ics.uci.edu/dataset/280/higgs>`_ 
     - quickstart, classification, tabular


Advanced Examples
-----------------
Advanced Examples are mostly for users that are both familiar with Federated Learning but also somewhat familiar with Flower's main features.

.. list-table::
   :widths: 50 15 15 15
   :header-rows: 1

   * - Title
     - Framework
     - Dataset
     - Tags

   * - `Federated Learning with PyTorch and Flower (Advanced Example) <advanced-pytorch.html>`_ 
     - `torch <https://pytorch.org/>`_, `torchvision <https://pytorch.org/vision/stable/index.html>`_ 
     - Fashion-MNIST 
     - advanced, vision, fds, wandb

   * - `Advanced Flower Example (TensorFlow/Keras) <advanced-tensorflow.html>`_ 
     - `tensorflow <https://www.tensorflow.org/>`_, `Keras <https://keras.io/>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - advanced, vision, fds

   * - `Flower Federations with Authentication 🧪 <flower-authentication.html>`_ 
     - `torch <https://pytorch.org/>`_, `torchvision <https://pytorch.org/vision/stable/index.html>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - advanced, vision, fds

   * - `Secure aggregation with Flower (the SecAgg+ protocol) <flower-secure-aggregation.html>`_ 
     - `torch <https://pytorch.org/>`_, `torchvision <https://pytorch.org/vision/stable/index.html>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - advanced, secure_aggregation, privacy

   * - `Vertical Federated Learning with Flower <vertical-fl.html>`_ 
     - `torch <https://pytorch.org/>`_, `pandas <https://pandas.pydata.org/>`_, `scikit-learn <https://scikit-learn.org/>`_ 
     - `Titanic <https://www.kaggle.com/competitions/titanic>`_ 
     - vertical, tabular, advanced

   * - `Federated Learning with XGBoost and Flower (Comprehensive Example) <xgboost-comprehensive.html>`_ 
     - `xgboost <https://xgboost.readthedocs.io/en/stable/>`_ 
     - `HIGGS <https://archive.ics.uci.edu/dataset/280/higgs>`_ 
     - advanced, classification, tabular


Other Examples
--------------
Flower Examples are a collection of example projects written with Flower that explore different domains and features. You can check which examples already exist and/or contribute your own example.

.. list-table::
   :widths: 50 15 15 15
   :header-rows: 1

   * - Title
     - Framework
     - Dataset
     - Tags

   * - `Flower Android Example (TensorFlowLite) <android.html>`_ 
     - `Android <https://www.android.com/>`_, `Java <https://www.java.com/>`_, `TensorFlowLite <https://www.tensorflow.org/lite>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - mobile, vision, sdk

   * - `Flower Android Client Example with Kotlin and TensorFlow Lite 2022 <android-kotlin.html>`_ 
     - `Android <https://www.android.com/>`_, `Kotlin <https://kotlinlang.org/>`_, `TensorFlowLite <https://www.tensorflow.org/lite>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - mobile, vision, sdk

   * - `Flower App (PyTorch) 🧪 <app-pytorch.html>`_ 
     - `torch <https://pytorch.org/>`_, `torchvision <https://pytorch.org/vision/stable/index.html>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - basic, vision, fds

   * - `Custom Metrics for Federated Learning with TensorFlow and Flower <custom-metrics.html>`_ 
     - `tensorflow <https://www.tensorflow.org/>`_, `scikit-learn <https://scikit-learn.org/>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - basic, vision, fds

   * - `Using custom mods 🧪 <custom-mods.html>`_ 
     - `wandb <https://wandb.ai/home>`_, `tensorboard <https://www.tensorflow.org/tensorboard>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - mods, monitoring, app

   * - `Federated Learning on Embedded Devices with Flower <embedded-devices.html>`_ 
     - `torch <https://pytorch.org/>`_, `tensorflow <https://www.tensorflow.org/>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_, `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - basic, vision, fds

   * - `Federated Survival Analysis with Flower and KaplanMeierFitter <federated-kaplan-meier-fitter.html>`_ 
     - `lifelines <https://lifelines.readthedocs.io/en/latest/index.html>`_ 
     - `Waltons <https://lifelines.readthedocs.io/en/latest/lifelines.datasets.html#lifelines.datasets.load_waltons>`_ 
     - estimator, medical

   * - `Flower Example on MNIST with Differential Privacy and Secure Aggregation <fl-dp-sa.html>`_ 
     - `torch <https://pytorch.org/>`_, `torchvision <https://pytorch.org/vision/stable/index.html>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - DP, SecAgg, vision, fds

   * - `Flower Example on Adult Census Income Tabular Dataset <fl-tabular.html>`_ 
     - `scikit-learn <https://scikit-learn.org/>`_, `torch <https://pytorch.org/>`_ 
     - `Adult Census Income <https://www.kaggle.com/datasets/uciml/adult-census-income/data>`_ 
     - basic, tabular, fds

   * - `30-minute tutorial running Flower simulation with PyTorch <flower-in-30-minutes.html>`_ 
     - `torch <https://pytorch.org/>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - colab, vision, simulation

   * - `Flower Simulation Step-by-Step <flower-simulation-step-by-step-pytorch.html>`_ 
     - `torch <https://pytorch.org/>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - basic, vision, simulation

   * - `Leveraging Flower and Docker for Device Heterogeneity Management in Federated Learning <flower-via-docker-compose.html>`_ 
     - `Docker <https://www.docker.com/>`_, `tensorflow <https://www.tensorflow.org/>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - deployment, vision, tutorial

   * - `FlowerTune LLM: Federated LLM Fine-tuning with Flower <flowertune-llm.html>`_ 
     - `PEFT <https://huggingface.co/docs/peft/index>`_, `torch <https://pytorch.org/>`_ 
     - `Alpaca-GPT4 <https://huggingface.co/datasets/vicgalle/alpaca-gpt4>`_ 
     - llm, nlp, LLama

   * - `Federated Finetuning of a Vision Transformer with Flower <flowertune-vit.html>`_ 
     - `torch <https://pytorch.org/>`_, `torchvision <https://pytorch.org/vision/stable/index.html>`_ 
     - `Oxford Flower-102 <https://www.robots.ox.ac.uk/~vgg/data/flowers/102/>`_ 
     - finetuning, vision, fds

   * - `FLiOS - A Flower SDK for iOS Devices with Example <ios.html>`_ 
     - `Swift <https://www.swift.org/>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - mobile, vision, sdk

   * - `Training with Sample-Level Differential Privacy using Opacus Privacy Engine <opacus.html>`_ 
     - `opacus <https://opacus.ai/>`_, `torch <https://pytorch.org/>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - DP, DP-SGD, basic, vision, fds, privacy

   * - `Federated Variational Autoencoder with PyTorch and Flower <pytorch-federated-variational-autoencoder.html>`_ 
     - `torch <https://pytorch.org/>`_, `torchvision <https://pytorch.org/vision/stable/index.html>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - basic, vision, fds

   * - `PyTorch: From Centralized To Federated <pytorch-from-centralized-to-federated.html>`_ 
     - `torch <https://pytorch.org/>`_ 
     - `CIFAR-10 <https://huggingface.co/datasets/uoft-cs/cifar10>`_ 
     - basic, vision, fds

   * - `Flower Logistic Regression Example using scikit-learn and Flower (Quickstart Example) <sklearn-logreg-mnist.html>`_ 
     - `scikit-learn <https://scikit-learn.org/>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - basic, vision, logistic regression, fds

   * - `Training with Sample-Level Differential Privacy using TensorFlow-Privacy Engine <tensorflow-privacy.html>`_ 
     - `tensorflow <https://www.tensorflow.org/>`_ 
     - `MNIST <https://huggingface.co/datasets/ylecun/mnist>`_ 
     - DP, DP-SGD, basic, vision, fds, privacy

   * - `On-device Federated Finetuning for Speech Classification <whisper-federated-finetuning.html>`_ 
     - `transformers <https://huggingface.co/docs/transformers/index>`_, `whisper <https://huggingface.co/openai/whisper-tiny>`_ 
     - `SpeechCommands <https://huggingface.co/datasets/google/speech_commands>`_ 
     - finetuning, speech, transformers


.. toctree::
  :maxdepth: 1
  :caption: Quickstart
  :hidden:

  quickstart-cpp
  quickstart-fastai
  quickstart-huggingface
  quickstart-jax
  quickstart-mlcube
  quickstart-mlx
  quickstart-monai
  quickstart-pandas
  quickstart-pytorch
  quickstart-pytorch-lightning
  quickstart-sklearn-tabular
  quickstart-tabnet
  quickstart-tensorflow
  xgboost-quickstart

.. toctree::
  :maxdepth: 1
  :caption: Advanced
  :hidden:

  advanced-pytorch
  advanced-tensorflow
  flower-authentication
  flower-secure-aggregation
  vertical-fl
  xgboost-comprehensive

.. toctree::
  :maxdepth: 1
  :caption: Others
  :hidden:

  android
  android-kotlin
  app-pytorch
  custom-metrics
  custom-mods
  embedded-devices
  federated-kaplan-meier-fitter
  fl-dp-sa
  fl-tabular
  flower-in-30-minutes
  flower-simulation-step-by-step-pytorch
  flower-via-docker-compose
  flowertune-llm
  flowertune-vit
  ios
  opacus
  pytorch-federated-variational-autoencoder
  pytorch-from-centralized-to-federated
  sklearn-logreg-mnist
  tensorflow-privacy
  whisper-federated-finetuning