Flower Framework Documentation
==============================

.. meta::
    :description: Check out the documentation of the main Flower Framework enabling easy Python development for Federated Learning.

Welcome to Flower's 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

Flower Framework
----------------

The user guide is targeted at researchers and developers who want to use Flower to bring
existing machine learning workloads into a federated setting. One of Flower's design
goals was to make this simple. Read on to learn more.

Tutorials
~~~~~~~~~

A learning-oriented series of federated learning tutorials, the best place to start.

.. toctree::
    :maxdepth: 1
    :caption: Tutorial

    tutorial-series-what-is-federated-learning
    tutorial-series-get-started-with-flower-pytorch
    tutorial-series-use-a-federated-learning-strategy-pytorch
    tutorial-series-build-a-strategy-from-scratch-pytorch
    tutorial-series-customize-the-client-pytorch

.. toctree::
    :maxdepth: 1
    :hidden:

    tutorial-quickstart

QUICKSTART TUTORIALS: :doc:`PyTorch <tutorial-quickstart-pytorch>` | :doc:`TensorFlow
<tutorial-quickstart-tensorflow>` | :doc:`MLX <tutorial-quickstart-mlx>` | :doc:`🤗
Transformers <tutorial-quickstart-huggingface>` | :doc:`JAX <tutorial-quickstart-jax>` |
:doc:`Pandas <tutorial-quickstart-pandas>` | :doc:`fastai <tutorial-quickstart-fastai>`
| :doc:`PyTorch Lightning <tutorial-quickstart-pytorch-lightning>` | :doc:`scikit-learn
<tutorial-quickstart-scikitlearn>` | :doc:`XGBoost <tutorial-quickstart-xgboost>` |
:doc:`Android <tutorial-quickstart-android>` | :doc:`iOS <tutorial-quickstart-ios>`

..
    We also made video tutorials for PyTorch:

..
    .. youtube:: jOmmuzMIQ4c

..
    :width: 80%

..
    And TensorFlow:

..
    .. youtube:: FGTc2TQq7VM

..
    :width: 80%

How-to Guides
~~~~~~~~~~~~~

Problem-oriented how-to guides show step-by-step how to achieve a specific goal.

.. toctree::
    :titlesonly:
    :caption: How-to Guides

    Build <build>
    Simulate <simulate>
    Deploy <deploy>

Explanations
~~~~~~~~~~~~

Understanding-oriented concept guides explain and discuss key topics and underlying
ideas behind Flower and collaborative AI.

.. toctree::
    :maxdepth: 1
    :caption: Explanations

    explanation-federated-evaluation
    explanation-differential-privacy
    explanation-flower-architecture

References
~~~~~~~~~~

.. toctree::
    :titlesonly:
    :maxdepth: 2
    :caption: References

    reference

Contribute
~~~~~~~~~~

The Flower community welcomes contributions. The following docs are intended to help
along the way.

.. toctree::
    :titlesonly:
    :caption: Contributor docs

    Contribute <contribute>

..
    Indices and tables

..
    ------------------

..
    * :ref:`genindex`

..
    * :ref:`modindex`

..
    * :ref:`search`