Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update rtmpose docs #2642

Merged
merged 3 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/en/advanced_guides/customize_evaluation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Customize Evaluation

Coming soon.

Currently, you can refer to [Evaluation Tutorial of MMEngine](https://mmengine.readthedocs.io/en/latest/tutorials/evaluation.html) to customize your own evaluation.
4 changes: 2 additions & 2 deletions docs/en/user_guides/how_to_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ python ./tools/deploy.py \

Parameter descriptions:

- `deploy_cfg`: Deployment configuration specific to mmdeploy, including inference framework type, quantization, and whether the input shape is dynamic or static. The configuration files may have reference relationships, and `configs/mmpretrain/classification_ncnn_static.py` is an example.
- `deploy_cfg`: Deployment configuration specific to mmdeploy, including inference framework type, quantization, and whether the input shape is dynamic or static. The configuration files may have reference relationships, and `configs/mmpose/pose-detection_simcc_onnxruntime_dynamic.py` is an example.

- `model_cfg`: Model configuration specific to the mm algorithm library, e.g., `mmpose/configs/pose-detection_simcc_onnxruntime_dynamic.py`, independent of mmdeploy path.
- `model_cfg`: Model configuration specific to the mm algorithm library, e.g., `mmpose/configs/body_2d_keypoint/rtmpose/coco/rtmpose-m_8xb256-420e_aic-coco-256x192.py`, independent of mmdeploy path.

- `checkpoint`: Path to the torch model. It can be a local file path or a download link (e.g., `http/https`).

Expand Down
2 changes: 2 additions & 0 deletions docs/zh_cn/advanced_guides/customize_evaluation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Customize Evaluation

Coming soon.

Currently, you can refer to [Evaluation Tutorial of MMEngine](https://mmengine.readthedocs.io/en/latest/tutorials/evaluation.html) to customize your own evaluation.
4 changes: 2 additions & 2 deletions docs/zh_cn/user_guides/how_to_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ python ./tools/deploy.py \

参数描述:

- `deploy_cfg` : mmdeploy 针对此模型的部署配置,包含推理框架类型、是否量化、输入 shape 是否动态等。配置文件之间可能有引用关系,configs/mmpretrain/classification_ncnn_static.py 是一个示例。
- `deploy_cfg` : mmdeploy 针对此模型的部署配置,包含推理框架类型、是否量化、输入 shape 是否动态等。配置文件之间可能有引用关系,`configs/mmpose/pose-detection_simcc_onnxruntime_dynamic.py` 是一个示例。

- `model_cfg` : mm 算法库的模型配置,例如 mmpretrain/configs/vision_transformer/vit-base-p32_ft-64xb64_in1k-384.py,与 mmdeploy 的路径无关。
- `model_cfg` : mm 算法库的模型配置,例如 `mmpose/configs/body_2d_keypoint/rtmpose/coco/rtmpose-m_8xb256-420e_aic-coco-256x192.py`,与 mmdeploy 的路径无关。

- `checkpoint` : torch 模型路径。可以 http/https 开头,详见 mmcv.FileClient 的实现。

Expand Down
6 changes: 5 additions & 1 deletion projects/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ We also provide some documentation listed below to help you get started:

## Project List

- **[:zap:RTMPose](./rtmpose)**: Real-Time Multi-Person Pose Estimation toolkit based on MMPose
- **[:zap:RTMPose](./rtmpose)**: Real-Time Multi-Person Pose Estimation toolkit based on MMPose <sup>
<a href="https://openxlab.org.cn/apps/detail/mmpose/RTMPose">
<i>TRY IT NOW</i>
</a>
</sup>

<div align="center">
<img src="https://github.com/open-mmlab/mmpose/assets/13503330/5b637d76-41dd-4376-9a7f-854cd120799d" width=800 height=200 />
Expand Down
154 changes: 83 additions & 71 deletions projects/rtmpose/README.md

Large diffs are not rendered by default.

152 changes: 82 additions & 70 deletions projects/rtmpose/README_CN.md

Large diffs are not rendered by default.

Loading