diff --git a/README.md b/README.md index f2f2783643..f84e34e9ba 100644 --- a/README.md +++ b/README.md @@ -251,15 +251,21 @@ runner.train()
-Common Usage +Examples -- [Resume Training](https://mmengine.readthedocs.io/en/latest/examples/resume_training.html) -- [Speed up Training](https://mmengine.readthedocs.io/en/latest/examples/speed_up_training.html) -- [Save Memory on GPU](https://mmengine.readthedocs.io/en/latest/examples/save_gpu_memory.html) - [Train a GAN](https://mmengine.readthedocs.io/en/latest/examples/train_a_gan.html)
+
+Common Usage + +- [Resume Training](https://mmengine.readthedocs.io/en/latest/common_usage/resume_training.html) +- [Speed up Training](https://mmengine.readthedocs.io/en/latest/common_usage/speed_up_training.html) +- [Save Memory on GPU](https://mmengine.readthedocs.io/en/latest/common_usage/save_gpu_memory.html) + +
+
Design diff --git a/README_zh-CN.md b/README_zh-CN.md index 8baab6dfb6..17b5331284 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -251,15 +251,21 @@ runner.train()
-常用功能 +示例 -- [恢复训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/resume_training.html) -- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/speed_up_training.html) -- [节省显存](https://mmengine.readthedocs.io/zh_CN/latest/examples/save_gpu_memory.html) - [训练生成对抗网络](https://mmengine.readthedocs.io/zh_CN/latest/examples/train_a_gan.html)
+
+常用功能 + +- [恢复训练](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/resume_training.html) +- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/speed_up_training.html) +- [节省显存](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/save_gpu_memory.html) + +
+
架构设计 diff --git a/docs/en/examples/resume_training.md b/docs/en/common_usage/resume_training.md similarity index 100% rename from docs/en/examples/resume_training.md rename to docs/en/common_usage/resume_training.md diff --git a/docs/en/examples/save_gpu_memory.md b/docs/en/common_usage/save_gpu_memory.md similarity index 100% rename from docs/en/examples/save_gpu_memory.md rename to docs/en/common_usage/save_gpu_memory.md diff --git a/docs/en/examples/speed_up_training.md b/docs/en/common_usage/speed_up_training.md similarity index 100% rename from docs/en/examples/speed_up_training.md rename to docs/en/common_usage/speed_up_training.md diff --git a/docs/en/index.rst b/docs/en/index.rst index 0be053fab3..2a3f33765a 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -12,13 +12,18 @@ You can switch between Chinese and English documents in the lower-left corner of .. toctree:: :maxdepth: 1 - :caption: Common Usage + :caption: Examples - examples/resume_training.md - examples/speed_up_training.md - examples/save_gpu_memory.md examples/train_a_gan.md +.. toctree:: + :maxdepth: 1 + :caption: Common Usage + + common_usage/resume_training.md + common_usage/speed_up_training.md + common_usage/save_gpu_memory.md + .. toctree:: :maxdepth: 3 :caption: Tutorials diff --git a/docs/zh_cn/examples/resume_training.md b/docs/zh_cn/common_usage/resume_training.md similarity index 100% rename from docs/zh_cn/examples/resume_training.md rename to docs/zh_cn/common_usage/resume_training.md diff --git a/docs/zh_cn/examples/save_gpu_memory.md b/docs/zh_cn/common_usage/save_gpu_memory.md similarity index 100% rename from docs/zh_cn/examples/save_gpu_memory.md rename to docs/zh_cn/common_usage/save_gpu_memory.md diff --git a/docs/zh_cn/examples/speed_up_training.md b/docs/zh_cn/common_usage/speed_up_training.md similarity index 100% rename from docs/zh_cn/examples/speed_up_training.md rename to docs/zh_cn/common_usage/speed_up_training.md diff --git a/docs/zh_cn/index.rst b/docs/zh_cn/index.rst index 33a8a4b185..ca42738d5f 100644 --- a/docs/zh_cn/index.rst +++ b/docs/zh_cn/index.rst @@ -12,13 +12,18 @@ .. toctree:: :maxdepth: 1 - :caption: 常用功能 + :caption: 示例 - examples/resume_training.md - examples/speed_up_training.md - examples/save_gpu_memory.md examples/train_a_gan.md +.. toctree:: + :maxdepth: 1 + :caption: 常用功能 + + common_usage/resume_training.md + common_usage/speed_up_training.md + common_usage/save_gpu_memory.md + .. toctree:: :maxdepth: 3 :caption: 入门教程