Flower Documentation
====================

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


User Guide
----------

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.

.. toctree::
   :maxdepth: 1
   :caption: User Guide

   installation
   quickstart_tensorflow
   quickstart_pytorch
   quickstart_mxnet
   quickstart_scikitlearn
   evaluation
   strategies
   implementing-strategies
   saving-progress
   examples
   example_walkthrough_pytorch_mnist
   example-pytorch-from-centralized-to-federated
   example-mxnet-walk-through
   fedbn-example-pytorch-from-centralized-to-federated
   recommended-env-setup
   changelog


API Reference
-------------

.. toctree::
   :maxdepth: 3
   :caption: API Reference

   flwr <apiref-flwr>


Contributor Guide
-----------------

The Flower authors welcome external contributions. The following guides are
intended to help along the way.

.. toctree::
   :maxdepth: 1
   :caption: Contributor Guide

   getting-started-for-contributors
   good-first-contributions
   architecture
   release_process


About
-----

.. toctree::
   :maxdepth: 1
   :caption: About

   people
   organizations
   publications


.. Indices and tables
.. ------------------

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`