docs: improve the documentation framework.

docs/doc-requirements.txt

@@ -2,6 +2,10 @@
 cloudpickle
 pickle5==0.0.11; python_version < '3.8'
 protobuf>=3.9.2,<3.20
+rayfed-nightly
+myst-parser==0.18.1
+nbsphinx==0.8.9
+sphinx==5.3.0
 
 # The following dependencies are required for doc-building only.
 jinja2<3.1.0

docs/source/advanced_topic/architecture.md

@@ -0,0 +1,3 @@
+# The architecture of RayFed
+
+TBD

docs/source/advanced_topic/index.rst

@@ -0,0 +1,15 @@
+.. _advanced_topic:
+
+
+Advanced Topic
+=================
+
+The architecture of RayFed is illustrated in the `architecture <architecture.md>`_ .
+For a deeper understanding of the principles behind RayFed, refer to the `principle <principle.md>`_ .
+
+
+.. toctree::
+ :maxdepth: 1
+
+ architecture
+ principle

docs/source/advanced_topic/principle.md

@@ -0,0 +1,3 @@
+# The principle of RayFed
+
+TBD

docs/source/conf.py

@@ -19,6 +19,8 @@
  'sphinx.ext.intersphinx',
  'sphinx.ext.viewcode',
  'sphinx.ext.extlinks',
+ 'myst_parser',
+ 'nbsphinx',
 ]
 
 intersphinx_mapping = {

docs/source/getting_started/index.rst

@@ -0,0 +1,15 @@
+.. _getting_started:
+
+
+Getting Started
+=================
+
+Please follow the `installation <installation.md>`_ to get RayFed ready.
+
+Then, we encourage you to check `quick_start <quick_start.md>`_ and :ref:`tutorials` to play with RayFed.
+
+.. toctree::
+ :maxdepth: 1
+
+ installation
+ quick_start

docs/source/getting_started/installation.md

@@ -0,0 +1,12 @@
+# Installation
+
+Install it from pypi.
+
+```shell
+pip install -U rayfed
+```
+
+Install the nightly released version from pypi.
+
+```shell
+pip install -U rayfed-nightly

docs/source/getting_started/quick_start.md

@@ -0,0 +1,7 @@
+# Quick Start
+
+TBD
+
+## More Examples
+
+Check out [tutorials](../tutorials/index.rst) to get more examples.

docs/source/index.rst

@@ -1,6 +1,16 @@
 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**.
@@ -12,17 +22,38 @@ RayFed has the following highlight features:
 3. Very Restricted and Clear Data Perimeters
 4. Very Large Scale Federated Computing and Training
 
-Check out the :doc:`usage` section for further information, including
-how to :ref:`installation` the project.
+Check out the :ref:`getting_started` section for further information, including
+how to install the project.
 
 .. note::
 
  This project is under active development.
 
-Contents
---------
+Why RayFed
+==============
+TBD
 
-.. toctree::
+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`
 
- usage
- api

docs/source/tutorials/federated_learning_demo.ipynb

@@ -0,0 +1,18 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Federated learning on RayFed"
+ ]
+ }
+ ],
+ "metadata": {
+ "language_info": {
+ "name": "python"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/source/tutorials/index.rst

@@ -0,0 +1,13 @@
+.. _tutorials:
+
+Tutorials
+===============
+
+We hope you enjoy these tutorials from RayFed developers.
+
+.. toctree::
+ :maxdepth: 1
+
+ federated_learning_demo
+ split_learning_demo
+ transition_from_ray_to_rayfed

docs/source/tutorials/split_learning_demo.ipynb

@@ -0,0 +1,18 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Split learning on RayFed"
+ ]
+ }
+ ],
+ "metadata": {
+ "language_info": {
+ "name": "python"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/source/tutorials/transition_from_ray_to_rayfed.ipynb

@@ -0,0 +1,18 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Seamless Federated, Transitioning from Ray to RayFed."
+ ]
+ }
+ ],
+ "metadata": {
+ "language_info": {
+ "name": "python"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}