.. # Copyright (C) 2020-2024 Intel Corporation
.. # SPDX-License-Identifier: Apache-2.0.


.. Documentation master file, created by
   sphinx-quickstart on Thu Oct 24 15:07:19 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=====================================================================
Welcome to the Open Federated Learning (|productName|) Documentation!
=====================================================================

Open Federated Learning (|productName|) is a Python\* \ 3 library for federated learning that enables organizations to collaboratively train a model without sharing sensitive information.

|productName| is Deep Learning framework-agnostic. 
Training of statistical models may be done with any deep learning framework, such as 
`TensorFlow <https://www.tensorflow.org/>`_\* \ or `PyTorch <https://pytorch.org/>`_\*\, via a plugin mechanism.


|productName| is a community supported project, originally developed by Intel Labs and the Intel Internet of Things Group. The team would like to encourage any contributions, notes, or requests to improve the documentation.

Looking for the Open Flash Library project also referred to as OpenFL? Find it `here <https://www.openfl.org/>`_!

.. toctree::
   :hidden:
   :caption: ABOUT
   :maxdepth: 2

   about/overview
   about/features
   about/releases
   about/blogs_publications
   about/license
   about/notices_and_disclaimers

.. toctree::
   :hidden:
   :caption: GET STARTED
   :maxdepth: 2

   get_started/installation
   get_started/quickstart
   get_started/examples

.. toctree::
   :hidden:
   :caption: DEVELOPER GUIDE
   :maxdepth: 2

   developer_guide/manual
   developer_guide/openfl_structure
 
.. toctree::
   :hidden:
   :caption: DEVELOPER REFERENCE
   :maxdepth: 2

   developer_ref/api_documentation
   developer_ref/troubleshooting

.. toctree::
   :hidden:
   :caption: CONTRIBUTING GUIDELINES
   :maxdepth: 2

   contributing_guidelines/contributing