Welcome to RayFed documentation!
===================================

.. toctree::
   :maxdepth: 2
   :titlesonly:
   :hidden:

   getting_started/index
   tutorials/index
   api
   advanced_topic/index


**RayFed** is a multiple parties joint, distributed execution engine based on Ray,
to help build your own federated learning frameworks **in minutes**.

RayFed has the following highlight features:

1. Ray Native Programming Pattern
2. Multiple Controller Execution Mode
3. Very Restricted and Clear Data Perimeters
4. Very Large Scale Federated Computing and Training

Check out the :ref:`getting_started` section for further information, including
how to install the project.

.. note::

   This project is under active development.

Why RayFed
==============
TBD

Getting Started
=================

Please check :ref:`getting_started` for installation and a quick start guide.


Tutorials
==============
- :doc:`tutorials/federated_learning_demo`
- :doc:`tutorials/split_learning_demo`
- :doc:`tutorials/transition_from_ray_to_rayfed`


API
==============
Check out `api <api.rst>`_ to write your own RayFed programs.


Architecture and principle of RayFed
======================================

To gain a comprehensive understanding of RayFed's architecture and principles,
we highly recommend reading :ref:`advanced_topic`