[Doc] Refine installation docs

open-mmlab · Sep 15, 2022 · a03eb5b · a03eb5b
1 parent a5131dc
commit a03eb5b
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -27,10 +27,10 @@
 [![Percentage of issues still open](https://isitmaintained.com/badge/open/open-mmlab/mmpose.svg)](https://github.com/open-mmlab/mmpose/issues)
 
 [📘Documentation](https://mmpose.readthedocs.io/en/1.x/) |
-[🛠️Installation](https://mmpose.readthedocs.io/en/1.x/install.html) |
-[👀Model Zoo](https://mmpose.readthedocs.io/en/1.x/modelzoo.html) |
-[📜Papers](https://mmpose.readthedocs.io/en/1.x/papers/algorithms.html) |
-[🆕Update News](https://mmpose.readthedocs.io/en/1.x/changelog.html) |
+[🛠️Installation](https://mmpose.readthedocs.io/en/1.x/installation.html) |
+[👀Model Zoo](https://mmpose.readthedocs.io/en/1.x/model_zoo.html) |
+[📜Papers](https://mmpose.readthedocs.io/en/1.x/model_zoo_papers/algorithms.html) |
+[🆕Update News](https://mmpose.readthedocs.io/en/1.x/notes/changelog.html) |
 [🤔Reporting Issues](https://github.com/open-mmlab/mmpose/issues/new/choose)
 
 </div>
@@ -99,13 +99,13 @@ Please refer to [installation.md](https://mmpose.readthedocs.io/en/1.x/installat
 
 We provided a series of tutorials about the basic usage of MMPose for new users:
 
-- [About Configs](https://mmpose.readthedocs.io/en/1.x/user_guides/configs.md)
-- [Add New Dataset](https://mmpose.readthedocs.io/en/1.x/user_guides/prepare_datasets.md)
-- [Keypoint Encoding & Decoding](https://mmpose.readthedocs.io/en/1.x/user_guides/codecs.md)
-- [Inference with Existing Models](https://mmpose.readthedocs.io/en/1.x/user_guides/inference.md)
-- [Train and Test](https://mmpose.readthedocs.io/en/1.x/user_guides/train_and_test.md)
-- [Visualization Tools](https://mmpose.readthedocs.io/en/1.x/user_guides/visualization.md)
-- [Other Useful Tools](https://mmpose.readthedocs.io/en/1.x/user_guides/useful_tools.md)
+- [About Configs](https://mmpose.readthedocs.io/en/1.x/user_guides/configs.html)
+- [Add New Dataset](https://mmpose.readthedocs.io/en/1.x/user_guides/prepare_datasets.html)
+- [Keypoint Encoding & Decoding](https://mmpose.readthedocs.io/en/1.x/user_guides/codecs.html)
+- [Inference with Existing Models](https://mmpose.readthedocs.io/en/1.x/user_guides/inference.html)
+- [Train and Test](https://mmpose.readthedocs.io/en/1.x/user_guides/train_and_test.html)
+- [Visualization Tools](https://mmpose.readthedocs.io/en/1.x/user_guides/visualization.html)
+- [Other Useful Tools](https://mmpose.readthedocs.io/en/1.x/user_guides/useful_tools.html)
 
 ## Model Zoo
 

diff --git a/README_CN.md b/README_CN.md
@@ -27,10 +27,10 @@
 [![Percentage of issues still open](https://isitmaintained.com/badge/open/open-mmlab/mmpose.svg)](https://github.com/open-mmlab/mmpose/issues)
 
 [📘文档](https://mmpose.readthedocs.io/zh_CN/1.x/) |
-[🛠️安装](https://mmpose.readthedocs.io/zh_CN/1.x/install.html) |
-[👀模型库](https://mmpose.readthedocs.io/zh_CN/1.x/modelzoo.html) |
-[📜论文库](https://mmpose.readthedocs.io/zh_CN/1.x/papers/algorithms.html) |
-[🆕更新日志](https://mmpose.readthedocs.io/en/1.x/changelog.html) |
+[🛠️安装](https://mmpose.readthedocs.io/zh_CN/1.x/installation.html) |
+[👀模型库](https://mmpose.readthedocs.io/zh_CN/1.x/model_zoo.html) |
+[📜论文库](https://mmpose.readthedocs.io/en/1.x/model_zoo_papers/algorithms.html) |
+[🆕更新日志](https://mmpose.readthedocs.io/en/1.x/notes/changelog.html) |
 [🤔报告问题](https://github.com/open-mmlab/mmpose/issues/new/choose)
 
 </div>
@@ -102,13 +102,13 @@ mim install -e
 
 我们提供了一系列简明的教程，帮助 MMPose 的新用户轻松上手使用：
 
-- [学习配置文件](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/configs.md)
-- [准备数据集](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/prepare_datasets.md)
-- [关键点编码、解码机制](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/codecs.md)
-- [使用现有模型推理](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/inference.md)
-- [模型训练和测试](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/train_and_test.md)
-- [可视化工具](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/visualization.md)
-- [其他实用工具](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/useful_tools.md)
+- [学习配置文件](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/configs.html)
+- [准备数据集](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/prepare_datasets.html)
+- [关键点编码、解码机制](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/codecs.html)
+- [使用现有模型推理](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/inference.html)
+- [模型训练和测试](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/train_and_test.html)
+- [可视化工具](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/visualization.html)
+- [其他实用工具](https://mmpose.readthedocs.io/zh_CN/1.x/user_guides/useful_tools.html)
 
 ## 模型库
 

diff --git a/demo/docs/2d_human_pose_demo.md b/demo/docs/2d_human_pose_demo.md
@@ -28,7 +28,6 @@ python demo/image_demo.py \
     https://download.openmmlab.com/mmpose/top_down/hrnet/hrnet_w48_coco_256x192-b9e0b3ab_20200708.pth \
     --out-file vis_results.jpg \
     --draw-heatmap
-
 ```
 
 To run this demo on CPU:

diff --git a/docs/en/installation.md b/docs/en/installation.md
@@ -65,6 +65,12 @@ mim install mmengine
 mim install "mmcv>=2.0.0rc1"
 ```
 
+Note that some of the demo scripts in MMPose require [MMDetection](https://github.com/open-mmlab/mmdetection) (mmdet)  for human detection. If you want to run these demo scripts with mmdet, you can install mmdet as a dependency by running:
+
+```shell
+mim install "mmdet>=3.0.0rc0"
+```
+
 **Step 1.** Install MMPose.
 
 Case A: To develop and run mmpose directly, install it from source:
@@ -88,7 +94,22 @@ mim install "mmpose>=1.0.0b0"
 
 ### Verify the installation
 
-To verify that MMPose is installed correctly, you can run an inference demo according to this [guide](/demo/docs/2d_human_pose_demo.md).
+To verify that MMPose is installed correctly, you can run the following inference demo script:
+
+```shell
+python demo/image_demo.py \
+    tests/data/coco/000000000785.jpg \
+    configs/body_2d_keypoint/topdown_heatmap/coco/td-hm_hrnet-w48_8xb32-210e_coco-256x192.py \
+    https://download.openmmlab.com/mmpose/top_down/hrnet/hrnet_w48_coco_256x192-b9e0b3ab_20200708.pth \
+    --out-file vis_results.jpg \
+    --draw-heatmap
+```
+
+If everything goes fine, you will get this visualization result:
+
+![image](https://user-images.githubusercontent.com/87690686/187824033-2cce0f55-034a-4127-82e2-52744178bc32.jpg)
+
+And the output will be saved as `$MMPOSE/vis_results.jpg`.
 
 ### Customize Installation
 

diff --git a/docs/zh_cn/installation.md b/docs/zh_cn/installation.md
@@ -64,6 +64,12 @@ mim install mmengine
 mim install "mmcv>=2.0.0rc1"
 ```
 
+请注意，MMPose 中的一些推理示例脚本需要使用 [MMDetection](https://github.com/open-mmlab/mmdetection) (mmdet) 检测人体。如果您想运行这些示例脚本，可以通过运行以下命令安装 mmdet:
+
+```shell
+mim install "mmdet>=3.0.0rc0"
+```
+
 **第 2 步** 安装 MMPose
 
 根据具体需求，我们支持两种安装模式: 从源码安装（推荐）和作为 Python 包安装
@@ -92,7 +98,22 @@ mim install "mmpose>=1.0.0b0"
 
 ### 验证安装
 
-为了验证 MMPose 的安装是否正确，您可以运行我们提供的 [示例代码](/demo/docs/2d_human_pose_demo.md) 来执行模型推理。
+为了验证 MMPose 是否安装正确，您可以运行以下推理示例脚本：
+
+```shell
+python demo/image_demo.py \
+    tests/data/coco/000000000785.jpg \
+    configs/body_2d_keypoint/topdown_heatmap/coco/td-hm_hrnet-w48_8xb32-210e_coco-256x192.py \
+    https://download.openmmlab.com/mmpose/top_down/hrnet/hrnet_w48_coco_256x192-b9e0b3ab_20200708.pth \
+    --out-file vis_results.jpg \
+    --draw-heatmap
+```
+
+如果一切顺利，您将会得到这样的可视化结果：
+
+![image](https://user-images.githubusercontent.com/87690686/187824033-2cce0f55-034a-4127-82e2-52744178bc32.jpg)
+
+输出图片将会保存到 `$MMPOSE/vis_results.jpg`.
 
 ### 自定义安装