diff --git a/docs/en/index.rst b/docs/en/index.rst index 5cfc1aa451..c55456b2a9 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -25,6 +25,8 @@ You can change the documentation language at the lower-left corner of the page. user_guides/prepare_datasets.md user_guides/train_and_test.md user_guides/how_to_deploy.md + user_guides/model_analysis.md + user_guides/dataset_tools.md .. toctree:: :maxdepth: 1 @@ -37,7 +39,6 @@ You can change the documentation language at the lower-left corner of the page. advanced_guides/customize_transforms.md advanced_guides/customize_optimizer.md advanced_guides/customize_logging.md - advanced_guides/model_analysis.md .. toctree:: :maxdepth: 1 @@ -79,7 +80,6 @@ You can change the documentation language at the lower-left corner of the page. dataset_zoo/2d_animal_keypoint.md dataset_zoo/3d_body_keypoint.md dataset_zoo/3d_hand_keypoint.md - dataset_zoo/dataset_tools.md .. toctree:: :maxdepth: 1 diff --git a/docs/en/overview.md b/docs/en/overview.md index b6e31dd239..42aa004158 100644 --- a/docs/en/overview.md +++ b/docs/en/overview.md @@ -43,6 +43,9 @@ We have prepared detailed guidelines for all types of users: - [Configs](./user_guides/configs.md) - [Prepare Datasets](./user_guides/prepare_datasets.md) - [Train and Test](./user_guides/train_and_test.md) + - [Deployment](./user_guides/how_to_deploy.md) + - [Model Analysis](./user_guides/model_analysis.md) + - [Dataset Annotation and Preprocessing](./user_guides/dataset_tools.md) 3. For developers who wish to develop based on MMPose: @@ -53,8 +56,6 @@ We have prepared detailed guidelines for all types of users: - [Customize Data Transforms](./advanced_guides/customize_transforms.md) - [Customize Optimizer](./advanced_guides/customize_optimizer.md) - [Customize Logging](./advanced_guides/customize_logging.md) - - [How to Deploy](./advanced_guides/how_to_deploy.md) - - [Model Analysis](./advanced_guides/model_analysis.md) - [Migration Guide](./migration.md) 4. For researchers and developers who are willing to contribute to MMPose: diff --git a/docs/en/dataset_zoo/dataset_tools.md b/docs/en/user_guides/dataset_tools.md similarity index 100% rename from docs/en/dataset_zoo/dataset_tools.md rename to docs/en/user_guides/dataset_tools.md diff --git a/docs/en/dataset_zoo/label_studio.md b/docs/en/user_guides/label_studio.md similarity index 100% rename from docs/en/dataset_zoo/label_studio.md rename to docs/en/user_guides/label_studio.md diff --git a/docs/en/advanced_guides/model_analysis.md b/docs/en/user_guides/model_analysis.md similarity index 100% rename from docs/en/advanced_guides/model_analysis.md rename to docs/en/user_guides/model_analysis.md diff --git a/docs/zh_cn/guide_to_framework.md b/docs/zh_cn/guide_to_framework.md index 4b9babc60d..5585b88179 100644 --- a/docs/zh_cn/guide_to_framework.md +++ b/docs/zh_cn/guide_to_framework.md @@ -1,4 +1,4 @@ -# 20 分钟了解 MMPose 架构设计 +# 20 分钟上手 MMPose MMPose 1.0 与之前的版本有较大改动，对部分模块进行了重新设计和组织，降低代码冗余度，提升运行效率，降低学习难度。 @@ -18,7 +18,7 @@ MMPose 1.0 采用了全新的模块结构设计以精简代码，提升运行效 以下是这篇教程的目录： -- [20 分钟了解 MMPose 架构设计](#20-分钟了解-mmpose-架构设计) +- [20 分钟上手 MMPose](#20-分钟上手-mmpose) - [文件结构](#文件结构) - [总览](#总览) - [Step1：配置文件](#step1配置文件) diff --git a/docs/zh_cn/index.rst b/docs/zh_cn/index.rst index 0e2feeb08c..a1647f8bbc 100644 --- a/docs/zh_cn/index.rst +++ b/docs/zh_cn/index.rst @@ -25,6 +25,8 @@ You can change the documentation language at the lower-left corner of the page. user_guides/prepare_datasets.md user_guides/train_and_test.md user_guides/how_to_deploy.md + user_guides/model_analysis.md + user_guides/dataset_tools.md .. toctree:: :maxdepth: 1 @@ -37,7 +39,6 @@ You can change the documentation language at the lower-left corner of the page. advanced_guides/customize_transforms.md advanced_guides/customize_optimizer.md advanced_guides/customize_logging.md - advanced_guides/model_analysis.md .. toctree:: :maxdepth: 1 @@ -79,7 +80,6 @@ You can change the documentation language at the lower-left corner of the page. dataset_zoo/2d_animal_keypoint.md dataset_zoo/3d_body_keypoint.md dataset_zoo/3d_hand_keypoint.md - dataset_zoo/dataset_tools.md .. toctree:: :maxdepth: 1 diff --git a/docs/zh_cn/overview.md b/docs/zh_cn/overview.md index 7ecd429862..f94f65c56d 100644 --- a/docs/zh_cn/overview.md +++ b/docs/zh_cn/overview.md @@ -43,6 +43,9 @@ MMPose 由 **8** 个主要部分组成，apis、structures、datasets、codecs - [配置文件](./user_guides/configs.md) - [准备数据集](./user_guides/prepare_datasets.md) - [训练与测试](./user_guides/train_and_test.md) + - [模型部署](./advanced_guides/how_to_deploy.md) + - [模型分析工具](./advanced_guides/model_analysis.md) + - [数据集标注与预处理脚本](./user_guides/dataset_tools.md) 3. 对于希望基于 MMPose 进行开发的研究者和开发者： @@ -53,8 +56,6 @@ MMPose 由 **8** 个主要部分组成，apis、structures、datasets、codecs - [自定义数据变换](./advanced_guides/customize_transforms.md) - [自定义优化器](./advanced_guides/customize_optimizer.md) - [自定义日志](./advanced_guides/customize_logging.md) - - [模型部署](./advanced_guides/how_to_deploy.md) - - [模型分析工具](./advanced_guides/model_analysis.md) - [迁移指南](./migration.md) 4. 对于希望加入开源社区，向 MMPose 贡献代码的研究者和开发者： diff --git a/docs/zh_cn/dataset_zoo/dataset_tools.md b/docs/zh_cn/user_guides/dataset_tools.md similarity index 100% rename from docs/zh_cn/dataset_zoo/dataset_tools.md rename to docs/zh_cn/user_guides/dataset_tools.md diff --git a/docs/zh_cn/dataset_zoo/label_studio.md b/docs/zh_cn/user_guides/label_studio.md similarity index 100% rename from docs/zh_cn/dataset_zoo/label_studio.md rename to docs/zh_cn/user_guides/label_studio.md diff --git a/docs/zh_cn/advanced_guides/model_analysis.md b/docs/zh_cn/user_guides/model_analysis.md similarity index 100% rename from docs/zh_cn/advanced_guides/model_analysis.md rename to docs/zh_cn/user_guides/model_analysis.md