[Docs] Update documentations links in README

open-mmlab · Dec 6, 2022 · 3a5f571 · 3a5f571
1 parent 2f24f39
commit 3a5f571
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -208,6 +208,71 @@ runner.train()
 
 </details>
 
+## Learn More
+
+<details>
+<summary>Tutorials</summary>
+
+- [Runner](https://mmengine.readthedocs.io/en/latest/tutorials/runner.html)
+- [Dataset and DataLoader](https://mmengine.readthedocs.io/en/latest/tutorials/dataset.html)
+- [Model](https://mmengine.readthedocs.io/en/latest/tutorials/model.html)
+- [Evaluation](https://mmengine.readthedocs.io/en/latest/tutorials/evaluation.html)
+- [OptimWrapper](https://mmengine.readthedocs.io/en/latest/tutorials/optim_wrapper.html)
+- [Parameter Scheduler](https://mmengine.readthedocs.io/en/latest/tutorials/param_scheduler.html)
+- [Hook](https://mmengine.readthedocs.io/en/latest/tutorials/hook.html)
+
+</details>
+
+<details>
+<summary>Advanced tutorials</summary>
+
+- [Registry](https://mmengine.readthedocs.io/en/latest/tutorials/registry.html)
+- [Config](https://mmengine.readthedocs.io/en/latest/tutorials/config.html)
+- [BaseDataset](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/basedataset.html)
+- [Data Transform](https://mmengine.readthedocs.io/en/latest/tutorials/data_transform.html)
+- [Initialization](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/initialize.html)
+- [Visualization](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/visualization.html)
+- [Abstract Data Element](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/data_element.html)
+- [Distribution Communication](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/distributed.html)
+- [Logging](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/logging.html)
+- [File IO](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/fileio.html)
+- [Global manager (ManagerMixin)](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/manager_mixin.html)
+- [Use modules from other libraries](https://mmengine.readthedocs.io/en/latest/advanced_tutorials/cross_library.html)
+
+</details>
+
+<details>
+<summary>Examples</summary>
+
+- [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)
+
+</details>
+
+<details>
+<summary>Design</summary>
+
+- [Hook](https://mmengine.readthedocs.io/en/latest/design/hook.html)
+- [Runner](https://mmengine.readthedocs.io/en/latest/design/runner.html)
+- [Evaluation](https://mmengine.readthedocs.io/en/latest/design/evaluation.html)
+- [Visualization](https://mmengine.readthedocs.io/en/latest/design/visualization.html)
+- [Logging](https://mmengine.readthedocs.io/en/latest/design/logging.html)
+
+</details>
+
+<details>
+<summary>Migration guide</summary>
+
+- [Migrate Runner from MMCV to MMEngine](https://mmengine.readthedocs.io/en/latest/migration/runner.html)
+- [Migrate Hook from MMCV to MMEngine](https://mmengine.readthedocs.io/en/latest/migration/hook.html)
+- [Migrate Model from MMCV to MMEngine](https://mmengine.readthedocs.io/en/latest/migration/model.html)
+- [Migrate Parameter Scheduler from MMCV to MMEngine](https://mmengine.readthedocs.io/en/latest/migration/param_scheduler.html)
+- [Migrate Data Transform to OpenMMLab 2.0](https://mmengine.readthedocs.io/en/latest/migration/transform.html)
+
+</details>
+
 ## Contributing
 
 We appreciate all contributions to improve MMEngine. Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for the contributing guideline.

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -224,59 +224,61 @@ runner.train()
 - [配置](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/config.html)
 - [执行器](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/runner.html)
 - [钩子](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/hook.html)
+- [数据集与数据加载器](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/dataset.html)
 - [模型](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/model.html)
 - [评测指标和评测器](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/evaluation.html)
 - [优化器](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/optim_wrapper.html)
 - [优化器参数调整策略](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/param_scheduler.html)
 - [数据变换](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/data_transform.html)
+- [钩子](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/hook.html)
 
 </details>
 
 <details>
 <summary>进阶教程</summary>
 
+- [注册器](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/registry.html)
+- [配置](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/config.html)
 - [数据集基类](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/basedataset.html)
 - [抽象数据接口](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/data_element.html)
 - [可视化](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/visualization.html)
+- [数据变换](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/data_transform.html)
 - [初始化](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/initialize.html)
+- [可视化](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/visualization.html)
+- [抽象数据接口](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/data_element.html)
 - [分布式通信原语](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/distributed.html)
 - [记录日志](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/logging.html)
 - [文件读写](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/fileio.html)
 - [辅助类](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/utils.html)
+- [全局管理器](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/manager_mixin.html)
+- [跨库调用模块](https://mmengine.readthedocs.io/zh_CN/latest/advanced_tutorials/cross_library.html)
 
 </details>
 
 <details>
 <summary>示例</summary>
-
 - [恢复训练](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/cross_library.html)
 - [训练生成对抗网络](https://mmengine.readthedocs.io/zh_CN/latest/examples/train_a_gan.html)
 
 </details>
-
 <details>
 <summary>架构设计</summary>
-
 - [钩子的设计](https://mmengine.readthedocs.io/zh_CN/latest/design/hook.html)
 - [执行器的设计](https://mmengine.readthedocs.io/zh_CN/latest/design/runner.html)
 - [模型精度评测的设计](https://mmengine.readthedocs.io/zh_CN/latest/design/evaluation.html)
 - [可视化的设计](https://mmengine.readthedocs.io/zh_CN/latest/design/visualization.html)
 - [日志系统的设计](https://mmengine.readthedocs.io/zh_CN/latest/design/logging.html)
-
 </details>
-
 <details>
 <summary>迁移指南</summary>
-
 - [迁移 MMCV 执行器到 MMEngine](https://mmengine.readthedocs.io/zh_CN/latest/migration/runner.html)
 - [迁移 MMCV 钩子到 MMEngine](https://mmengine.readthedocs.io/zh_CN/latest/migration/hook.html)
 - [迁移 MMCV 模型到 MMEngine](https://mmengine.readthedocs.io/zh_CN/latest/migration/model.html)
 - [迁移 MMCV 参数调度器到 MMEngine](https://mmengine.readthedocs.io/zh_CN/latest/migration/param_scheduler.html)
 - [数据变换类的迁移](https://mmengine.readthedocs.io/zh_CN/latest/migration/transform.html)
-
 </details>
 
 ## 贡献指南

diff --git a/docs/en/advanced_tutorials/distributed.md b/docs/en/advanced_tutorials/distributed.md
@@ -1,4 +1,4 @@
-# Distribution communication
+# Distribution Communication
 
 In distributed training, different processes sometimes need to apply different logics depending on their ranks, local_ranks, etc.
 They also need to communicate with each other and do synchronizations on data.

diff --git a/docs/en/examples/resume_training.md b/docs/en/examples/resume_training.md
@@ -1,4 +1,4 @@
-# Resume training
+# Resume Training
 
 Resuming training means continuing training from the state saved from some previous training, where the state includes the model's weights, the state of the optimizer and the state of parameter scheduler.
 

diff --git a/docs/en/examples/save_gpu_memory.md b/docs/en/examples/save_gpu_memory.md
@@ -1,3 +1,3 @@
-# Save memory on GPU
+# Save Memory on GPU
 
 Coming soon. Please refer to [chinese documentation](https://mmengine.readthedocs.io/zh_CN/latest/examples/save_gpu_memory.html).
diff --git a/docs/en/examples/speed_up_training.md b/docs/en/examples/speed_up_training.md
@@ -1,4 +1,4 @@
-# Speed up training
+# Speed up Training
 
 ## Distributed Training
 

diff --git a/docs/en/migration/transform.md b/docs/en/migration/transform.md
@@ -1,3 +1,3 @@
-# Migrate Transform from MMCV to MMEngine
+# Migrate Data Transform to OpenMMLab 2.0
 
 Coming soon. Please refer to [chinese documentation](https://mmengine.readthedocs.io/zh_CN/latest/migration/transform.html).