📝 [Refactor] the docs language from md to rst

docs/0_get_start/0_quick_start.md

@@ -1 +0,0 @@
-# Quick Start

docs/0_get_start/0_quick_start.rst

@@ -0,0 +1,69 @@
+Quick Start
+===========
+
+.. note::
+   We expect all customizations to be done primarily by passing arguments or modifying the YAML config files.
+   If more detailed modifications are needed, custom content should be modularized as much as possible to avoid extensive code modifications.
+
+Install YOLO
+------------
+
+Clone the repository and install the dependencies:
+
+.. code-block:: bash
+
+   git clone https://github.com/WongKinYiu/YOLO.git
+   cd YOLO
+   pip install -r requirements-dev.txt
+   # Make sure to work inside the cloned folder.
+
+Alternatively, If you are planning to make a simple change:
+
+**Note**: In the following examples, you should replace ``python yolo/lazy.py`` with ``yolo`` .
+
+.. code-block:: bash
+
+   pip install git+https://github.com/WongKinYiu/YOLO.git
+
+**Note**: Most tasks already include at yolo/lazy.py, so you can run with this prefix and follow arguments: ``python yolo/lazy.py``
+
+
+Train Model
+-----------
+
+To train the model, use the following command:
+
+.. code-block:: bash
+
+   python yolo/lazy.py task=train
+
+   yolo task=train # if installed via pip
+
+- Overriding the ``dataset`` parameter, you can customize your dataset via a dataset config.
+- Overriding YOLO model by setting the ``model`` parameter to ``{v9-c, v9-m, ...}``.
+- More details can be found at :ref:`Train Tutorials<Train>`.
+
+For example:
+
+.. code-block:: bash
+
+   python yolo/lazy.py task=train dataset=AYamlFilePath model=v9-m
+
+   yolo task=train dataset=AYamlFilePath model=v9-m # if installed via pip
+
+Inference & Deployment
+------------------------
+
+Inference is the default task of ``yolo/lazy.py``. To run inference and deploy the model, use:
+More details can be found at :ref:`Inference Tutorials <Inference>`.
+
+.. code-block:: bash
+
+   python yolo/lazy.py task.data.source=AnySource
+
+   yolo task.data.source=AnySource # if installed via pip
+
+You can enable fast inference modes by adding the parameter ``task.fast_inference={onnx, trt, deploy}``.
+
+- Theoretical acceleration following :ref:`YOLOv9 <Deploy>`.
+- Hardware acceleration like :ref:`ONNX <ONNX>` and :ref:`TensorRT <TensorRT>`. for optimized deployment.

docs/0_get_start/1_installations.md

@@ -1,4 +0,0 @@
-# Install YOLO
-
-## GPU (Cuda / MPS)
-## CPU only

docs/0_get_start/1_installations.rst

@@ -0,0 +1,15 @@
+Install YOLO
+============
+
+Git
+---
+
+pypi(pip install)
+-----------------
+
+Docker
+------
+
+Conda
+-----
+[WIP]

docs/0_get_start/2_git.md

@@ -1,3 +0,0 @@
-# Install via Git& GitHub
-
-## [WIP]

docs/0_get_start/3_pypi.md

@@ -1,3 +0,0 @@
-# Install via PyPi(pip install)
-
-## [WIP]

docs/0_get_start/4_docker.md

@@ -1,3 +0,0 @@
-# Install in Docker
-
-## [WIP]

docs/0_get_start/5_conda.md

@@ -1,3 +0,0 @@
-# Install in Conda env
-
-## [WIP]

docs/1_tutorials/0_train.md

@@ -1,5 +0,0 @@
-# Train
-
-## Train on COCO2017
-
-## Train on Cusom Dataset

docs/1_tutorials/0_train.rst

@@ -0,0 +1,10 @@
+.. _Train:
+
+Train
+=====
+
+Train on COCO2017
+-----------------
+
+Train on Cusom Dataset
+-----------------

docs/1_tutorials/1_validation.md

@@ -1,5 +0,0 @@
-# Validation
-
-## Validation on COCO2017
-
-## Validation on Custom Dataset

docs/1_tutorials/1_validation.rst

@@ -0,0 +1,11 @@
+.. _Validation:
+
+Validation
+==========
+
+
+Validation on COCO2017
+----------------------
+
+Validation on Custom Dataset
+----------------------------

docs/1_tutorials/2_inference.rst

@@ -0,0 +1,11 @@
+.. _Inference:
+
+Inference
+==========
+
+
+Inference Video
+---------------
+
+Inference Image
+---------------

docs/2_model_zoo/0_object_detection.md

@@ -1,5 +0,0 @@
-# Object Detection
-
-## YOLOv7
-
-## YOLOv9

docs/2_model_zoo/0_object_detection.rst

@@ -0,0 +1,8 @@
+Object Detection
+================
+
+YOLOv7
+------
+
+YOLOv9
+------

docs/2_model_zoo/1_segmentation.md

@@ -1,5 +0,0 @@
-# Segmentations
-
-## YOLOv7
-
-## YOLOv9

docs/2_model_zoo/1_segmentation.rst

@@ -0,0 +1,8 @@
+Segmentations
+=============
+
+YOLOv7
+------
+
+YOLOv9
+------

docs/2_model_zoo/2_classification.md

@@ -1,5 +0,0 @@
-# Classification
-
-## YOLOv7
-
-## YOLOv9

docs/2_model_zoo/2_classification.rst

@@ -0,0 +1,4 @@
+Classification
+==============
+
+[WIP]

docs/3_custom/0_model.md

@@ -1 +0,0 @@
-# Model

docs/3_custom/0_model.rst

@@ -0,0 +1,4 @@
+.. _Model:
+
+Model
+=====

docs/3_custom/1_data_augment.md

@@ -1 +0,0 @@
-# Data Augment

docs/3_custom/1_data_augment.rst

@@ -0,0 +1,4 @@
+.. _DataAugment:
+
+Data Augment
+============

docs/3_custom/2_loss.md

@@ -1 +0,0 @@
-# Loss

docs/3_custom/2_loss.rst

@@ -0,0 +1,4 @@
+.. _Loss:
+
+Loss
+====

docs/3_custom/3_task.md

@@ -1 +0,0 @@
-# Task

docs/3_custom/3_task.rst

@@ -0,0 +1,4 @@
+.. _Task:
+
+Task
+====

docs/4_deploy/1_deploy.md

@@ -1,3 +0,0 @@
-# Deploy YOLOv9
-
-# Deploy YOLOv7

docs/4_deploy/1_deploy.rst

@@ -0,0 +1,10 @@
+.. _Deploy:
+
+Deploy Model
+============
+
+Deploy YOLOv9
+-------------
+
+Deploy YOLOv7
+-------------

docs/4_deploy/2_onnx.md

@@ -1 +0,0 @@
-# Compile to ONNX

docs/4_deploy/2_onnx.rst

@@ -0,0 +1,4 @@
+.. _ONNX:
+
+Compile to ONNX
+===============

docs/4_deploy/3_tensorrt.md

@@ -1 +0,0 @@
-# Compile to TensorRT

docs/4_deploy/3_tensorrt.rst

@@ -0,0 +1,5 @@
+.. _TensorRT:
+
+
+Compile to TensorRT
+===================

docs/5_features/0_small_object.rst

@@ -0,0 +1,4 @@
+.. _Small Object:
+
+Small Object
+============

docs/5_features/1_version_convert.rst

@@ -0,0 +1,4 @@
+.. _Version Convert:
+
+Version Convert
+===============

docs/5_features/2_IPython.rst

@@ -0,0 +1,4 @@
+.. _IPython:
+
+IPython
+=======

docs/6_function_docs/0_solver.rst

@@ -0,0 +1,4 @@
+.. _Solver:
+
+Solver
+======

docs/6_function_docs/1_tools.rst

@@ -0,0 +1,4 @@
+.. _Tools:
+
+Useful Tools
+============

docs/6_function_docs/2_module.rst

@@ -0,0 +1,4 @@
+.. _Module:
+
+Model Module
+============

docs/conf.py

@@ -13,6 +13,11 @@ author = "Kin-Yiu, Wong and Hao-Tang, Tsui"
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx_rtd_theme",

docs/index.rst

@@ -25,55 +25,60 @@ Explore our documentation:
    :maxdepth: 2
    :caption: Get Started
 
-   0_get_start/0_quick_start.md
-   0_get_start/1_installations.md
-   0_get_start/2_git.md
-   0_get_start/3_pypi.md
-   0_get_start/4_docker.md
-   0_get_start/5_conda.md
+   0_get_start/0_quick_start
+   0_get_start/1_installations
 
 .. toctree::
    :maxdepth: 2
    :caption: Tutorials
 
-   1_tutorials/0_train.md
-   1_tutorials/1_validation.md
+   1_tutorials/0_train
+   1_tutorials/1_validation
+   1_tutorials/2_inference
 
 
 .. toctree::
    :maxdepth: 2
    :caption: Model Zoo
 
-   2_model_zoo/0_object_detection.md
-   2_model_zoo/1_segmentation.md
-   2_model_zoo/2_classification.md
+   2_model_zoo/0_object_detection
+   2_model_zoo/1_segmentation
+   2_model_zoo/2_classification
 
 .. toctree::
    :maxdepth: 2
    :caption: Custom YOLO
 
-   3_custom/0_model.md
-   3_custom/1_data_augment.md
-   3_custom/2_loss.md
-   3_custom/3_task.md
+   3_custom/0_model
+   3_custom/1_data_augment
+   3_custom/2_loss
+   3_custom/3_task
 
 
 .. toctree::
    :maxdepth: 2
    :caption: Deploy
 
-   4_deploy/1_deploy.md
-   4_deploy/2_onnx.md
-   4_deploy/3_tensorrt.md
+   4_deploy/1_deploy
+   4_deploy/2_onnx
+   4_deploy/3_tensorrt
 
 
 .. toctree::
    :maxdepth: 2
-   :caption: Deploy
+   :caption: Features
+
+   5_features/0_small_object
+   5_features/1_version_convert
+   5_features/2_IPython
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Function Docs
 
-   4_deploy/1_deploy.md
-   4_deploy/2_onnx.md
-   4_deploy/3_tensorrt.md
+   6_function_docs/0_solver
+   6_function_docs/1_tools
+   6_function_docs/2_module
 
 License
 -------