[Doc] fix api reference (open-mmlab#1792)

shuheilocale · Nov 11, 2022 · 22438d1 · 22438d1
1 parent 1faf505
commit 22438d1
Show file tree

Hide file tree

Showing 20 changed files with 440 additions and 1,217 deletions.
diff --git a/.github/workflows/merge_stage_test.yml b/.github/workflows/merge_stage_test.yml
@@ -180,24 +180,24 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Upgrade pip
-        run: pip install pip --upgrade
+        run: python -m pip install pip --upgrade
       - name: Install lmdb
-        run: pip install lmdb
+        run: python -m pip install lmdb
       - name: Install PyTorch
-        run: pip install torch==1.8.1+${{matrix.platform}} torchvision==0.9.1+${{matrix.platform}} -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html
+        run: python -m pip install torch==1.8.1+${{matrix.platform}} torchvision==0.9.1+${{matrix.platform}} -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html
       - name: Install mmpose dependencies
         run: |
-          pip install -U numpy
-          pip install git+https://github.com/open-mmlab/mmengine.git@main
-          pip install -U openmim
+          python -m pip install -U numpy
+          python -m pip install git+https://github.com/open-mmlab/mmengine.git@main
+          python -m pip install -U openmim
           mim install 'mmcv >= 2.0.0rc1'
-          pip install git+https://github.com/open-mmlab/[email protected]
-          pip install -r requirements/tests.txt
-          pip install -r requirements/albu.txt
-          pip install -r requirements/poseval.txt
+          python -m pip install git+https://github.com/open-mmlab/[email protected]
+          python -m pip install -r requirements/tests.txt
+          python -m pip install -r requirements/albu.txt
+          python -m pip install -r requirements/poseval.txt
       - name: Build and install
         run: |
-          pip install -e .
+          python -m pip install -e .
       - name: Run unittests and generate coverage report
         run: |
           pytest tests/
diff --git a/.github/workflows/pr_stage_test.yml b/.github/workflows/pr_stage_test.yml
@@ -120,24 +120,24 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Upgrade pip
-        run: pip install pip --upgrade
+        run: python -m pip install pip --upgrade
       - name: Install lmdb
-        run: pip install lmdb
+        run: python -m pip install lmdb
       - name: Install PyTorch
-        run: pip install torch==1.8.1+${{matrix.platform}} torchvision==0.9.1+${{matrix.platform}} -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html
+        run: python -m pip install torch==1.8.1+${{matrix.platform}} torchvision==0.9.1+${{matrix.platform}} -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html
       - name: Install mmpose dependencies
         run: |
-          pip install -U numpy
-          pip install git+https://github.com/open-mmlab/mmengine.git@main
-          pip install -U openmim
+          python -m pip install -U numpy
+          python -m pip install git+https://github.com/open-mmlab/mmengine.git@main
+          python -m pip install -U openmim
           mim install 'mmcv >= 2.0.0rc1'
-          pip install git+https://github.com/open-mmlab/[email protected]
-          pip install -r requirements/tests.txt
-          pip install -r requirements/albu.txt
-          pip install -r requirements/poseval.txt
+          python -m pip install git+https://github.com/open-mmlab/[email protected]
+          python -m pip install -r requirements/tests.txt
+          python -m pip install -r requirements/albu.txt
+          python -m pip install -r requirements/poseval.txt
       - name: Build and install
         run: |
-          pip install -e .
+          python -m pip install -e .
       - name: Run unittests and generate coverage report
         run: |
           pytest tests/
diff --git a/demo/docs/webcam_demo.md b/demo/docs/webcam_demo.md
@@ -66,11 +66,11 @@ Detailed configurations can be found in the config file.
   In this demo we use two [top-down](https://github.com/open-mmlab/mmpose/tree/1.x/configs/body_2d_keypoint/topdown_heatmap) pose estimation models for humans and animals respectively. Users can choose models from the [MMPose Model Zoo](https://mmpose.readthedocs.io/en/1.x/modelzoo.html). To apply different pose models on different instance types, you can add multiple pose estimator nodes with `cls_names` set accordingly.
 
   ```python
-  # 'TopDownPoseEstimatorNode':
+  # 'TopdownPoseEstimatorNode':
   # This node performs keypoint detection from the frame image using an
   # MMPose top-down model. Detection results is needed.
   dict(
-      type='TopDownPoseEstimatorNode',
+      type='TopdownPoseEstimatorNode',
       name='human pose estimator',
       model_config='configs/wholebody_2d_keypoint/'
       'topdown_heatmap/coco-wholebody/'
@@ -82,7 +82,7 @@ Detailed configurations can be found in the config file.
       input_buffer='det_result',
       output_buffer='human_pose'),
   dict(
-      type='TopDownPoseEstimatorNode',
+      type='TopdownPoseEstimatorNode',
       name='animal pose estimator',
       model_config='configs/animal_2d_keypoint/topdown_heatmap/'
       'animalpose/td-hm_hrnet-w32_8xb64-210e_animalpose-256x256.py',

diff --git a/demo/webcam_cfg/pose_estimation.py b/demo/webcam_cfg/pose_estimation.py
@@ -27,11 +27,11 @@
             'scratch_600e_coco_20210629_110627-974d9307.pth',
             input_buffer='_input_',  # `_input_` is an executor-reserved buffer
             output_buffer='det_result'),
-        # 'TopDownPoseEstimatorNode':
+        # 'TopdownPoseEstimatorNode':
         # This node performs keypoint detection from the frame image using an
         # MMPose top-down model. Detection results is needed.
         dict(
-            type='TopDownPoseEstimatorNode',
+            type='TopdownPoseEstimatorNode',
             name='human pose estimator',
             model_config='configs/wholebody_2d_keypoint/'
             'topdown_heatmap/coco-wholebody/'
@@ -43,7 +43,7 @@
             input_buffer='det_result',
             output_buffer='human_pose'),
         dict(
-            type='TopDownPoseEstimatorNode',
+            type='TopdownPoseEstimatorNode',
             name='animal pose estimator',
             model_config='configs/animal_2d_keypoint/topdown_heatmap/'
             'animalpose/td-hm_hrnet-w32_8xb64-210e_animalpose-256x256.py',

diff --git a/docs/en/_static/css/readthedocs.css b/docs/en/_static/css/readthedocs.css
@@ -4,3 +4,7 @@
     height: 50px;
     width: 120px;
 }
+
+table.autosummary td {
+    width: 35%
+}
diff --git a/docs/en/api.rst b/docs/en/api.rst
@@ -3,14 +3,11 @@ mmpose.apis
 .. automodule:: mmpose.apis
     :members:
 
-
 mmpose.codecs
 -------------
-
 .. automodule:: mmpose.codecs
     :members:
 
-
 mmpose.models
 ---------------
 backbones
@@ -113,16 +110,27 @@ mmpose.registry
     :members:
 
 mmpose.evaluation
----------------
-.. automodule:: mmpose.evaluation
+-----------------
+metrics
+^^^^^^^^^^^
+.. automodule:: mmpose.evaluation.metrics
+    :members:
+
+functional
+^^^^^^^^^^^
+.. automodule:: mmpose.evaluation.functional
     :members:
 
 mmpose.visualization
----------------
+--------------------
 .. automodule:: mmpose.visualization
     :members:
 
 mmpose.engine
 ---------------
-.. automodule:: mmpose.engine
+hooks
+^^^^^^^^^^^
+.. automodule:: mmpose.engine.hooks
     :members:
+
+.. include:: webcam_api.rst
diff --git a/docs/en/conf.py b/docs/en/conf.py
@@ -44,7 +44,8 @@ def get_version():
 # ones.
 extensions = [
     'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode',
-    'sphinx_markdown_tables', 'sphinx_copybutton', 'myst_parser'
+    'sphinx_markdown_tables', 'sphinx_copybutton', 'myst_parser',
+    'sphinx.ext.autosummary'
 ]
 
 autodoc_mock_imports = ['json_tricks', 'mmpose.version']

diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -82,7 +82,6 @@ You can change the documentation language at the lower-left corner of the page.
    notes/faq.md
 
 .. toctree::
-   :maxdepth: 1
    :caption: API Reference
 
    api.rst

diff --git a/docs/en/webcam_api.rst b/docs/en/webcam_api.rst
@@ -0,0 +1,112 @@
+mmpose.apis.webcam
+--------------------
+.. contents:: MMPose Webcam API: Tools to build simple interactive webcam applications and demos
+    :depth: 2
+    :local:
+    :backlinks: top
+
+Executor
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    WebcamExecutor
+
+Nodes
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam.nodes
+
+Base Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    Node
+    BaseVisualizerNode
+
+Model Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    DetectorNode
+    TopdownPoseEstimatorNode
+
+Visualizer Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    ObjectVisualizerNode
+    NoticeBoardNode
+    SunglassesEffectNode
+    BigeyeEffectNode
+
+Helper Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    ObjectAssignerNode
+    MonitorNode
+    RecorderNode
+
+Utils
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam.utils
+
+Buffer and Message
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    BufferManager
+    Message
+    FrameMessage
+    VideoEndingMessage
+
+Pose
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    get_eye_keypoint_ids
+    get_face_keypoint_ids
+    get_hand_keypoint_ids
+    get_mouth_keypoint_ids
+    get_wrist_keypoint_ids
+
+Event
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    EventManager
+
+Misc
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    copy_and_paste
+    screen_matting
+    expand_and_clamp
+    limit_max_fps
+    is_image_file
+    get_cached_file_path
+    load_image_from_disk_or_url
+    get_config_path
diff --git a/docs/zh_cn/_static/css/readthedocs.css b/docs/zh_cn/_static/css/readthedocs.css
@@ -4,3 +4,7 @@
     height: 50px;
     width: 120px;
 }
+
+table.autosummary td {
+    width: 35%
+}
diff --git a/docs/zh_cn/api.rst b/docs/zh_cn/api.rst
@@ -3,14 +3,11 @@ mmpose.apis
 .. automodule:: mmpose.apis
     :members:
 
-
 mmpose.codecs
 -------------
-
 .. automodule:: mmpose.codecs
     :members:
 
-
 mmpose.models
 ---------------
 backbones
@@ -113,16 +110,27 @@ mmpose.registry
     :members:
 
 mmpose.evaluation
----------------
-.. automodule:: mmpose.evaluation
+-----------------
+metrics
+^^^^^^^^^^^
+.. automodule:: mmpose.evaluation.metrics
+    :members:
+
+functional
+^^^^^^^^^^^
+.. automodule:: mmpose.evaluation.functional
     :members:
 
 mmpose.visualization
----------------
+--------------------
 .. automodule:: mmpose.visualization
     :members:
 
 mmpose.engine
 ---------------
-.. automodule:: mmpose.engine
+hooks
+^^^^^^^^^^^
+.. automodule:: mmpose.engine.hooks
     :members:
+
+.. include:: webcam_api.rst
diff --git a/docs/zh_cn/conf.py b/docs/zh_cn/conf.py
@@ -44,7 +44,8 @@ def get_version():
 # ones.
 extensions = [
     'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode',
-    'sphinx_markdown_tables', 'sphinx_copybutton', 'myst_parser'
+    'sphinx_markdown_tables', 'sphinx_copybutton', 'myst_parser',
+    'sphinx.ext.autosummary'
 ]
 
 autodoc_mock_imports = ['json_tricks', 'mmpose.version']