mirror of
https://github.com/open-mmlab/mmengine.git
synced 2025-06-03 21:54:44 +08:00
[Docs] Fix index.rst in docs (#505)
* [Docs] Fix outdated index * update index.rst * fix readme url
This commit is contained in:
parent
58d8a41966
commit
ba1c368f94
@ -216,28 +216,42 @@ runner.train()
|
||||
## 了解更多
|
||||
|
||||
<details>
|
||||
<summary>教程</summary>
|
||||
<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/tutorials/runner.html)
|
||||
- [钩子](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/optimizer.html)
|
||||
- [优化器](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/param_scheduler.html)
|
||||
- [抽象数据接口](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/data_element.html)
|
||||
- [数据集基类](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/basedataset.html)
|
||||
- [评测指标和评测器](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/metric_and_evaluator.html)
|
||||
- [分布式通信原语](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/distributed.html)
|
||||
- [记录日志](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/logging.html)
|
||||
- [可视化](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/visualization.html)
|
||||
- [钩子](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/hook.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)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>进阶教程</summary>
|
||||
|
||||
- [数据集基类](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/advanced_tutorials/initialize.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)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>示例</summary>
|
||||
|
||||
- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/speed_up_training.html)
|
||||
- [恢复训练](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>
|
||||
|
||||
@ -246,16 +260,19 @@ runner.train()
|
||||
|
||||
- [钩子的设计](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/param_scheduler.html)
|
||||
- [迁移 MMCV 钩子到 MMEngine](https://mmengine.readthedocs.io/zh_CN/latest/migration/hook.html)
|
||||
- [迁移 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>
|
||||
|
@ -28,8 +28,8 @@ You can switch between Chinese and English documents in the lower-left corner of
|
||||
:maxdepth: 1
|
||||
:caption: Advanced tutorials
|
||||
|
||||
advanced_tutorials/data_element.md
|
||||
advanced_tutorials/basedataset.md
|
||||
advanced_tutorials/data_element.md
|
||||
advanced_tutorials/visualization.md
|
||||
advanced_tutorials/initialize.md
|
||||
advanced_tutorials/distributed.md
|
||||
@ -45,6 +45,7 @@ You can switch between Chinese and English documents in the lower-left corner of
|
||||
examples/speed_up_training.md
|
||||
examples/save_gpu_memory.md
|
||||
examples/cross_library.md
|
||||
examples/train_a_gan.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@ -60,10 +61,11 @@ You can switch between Chinese and English documents in the lower-left corner of
|
||||
:maxdepth: 1
|
||||
:caption: Migration guide
|
||||
|
||||
migration/runner.md
|
||||
migration/hook.md
|
||||
migration/transform.md
|
||||
migration/model.md
|
||||
migration/param_scheduler.md
|
||||
migration/runne.md
|
||||
migration/transform.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
3
docs/en/migration/model.md
Normal file
3
docs/en/migration/model.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Migrate Model from MMCV to MMEngine
|
||||
|
||||
Coming soon. Please refer to [chinese documentation](https://mmengine.readthedocs.io/zh_CN/latest/migration/model.html).
|
@ -37,12 +37,6 @@
|
||||
advanced_tutorials/fileio.md
|
||||
advanced_tutorials/utils.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 迁移指南
|
||||
|
||||
migration/migrate_model_from_mmcv.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 示例
|
||||
@ -51,6 +45,7 @@
|
||||
examples/speed_up_training.md
|
||||
examples/save_gpu_memory.md
|
||||
examples/cross_library.md
|
||||
examples/train_a_gan.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@ -66,10 +61,11 @@
|
||||
:maxdepth: 1
|
||||
:caption: 迁移指南
|
||||
|
||||
migration/runner.md
|
||||
migration/hook.md
|
||||
migration/transform.md
|
||||
migration/model.md
|
||||
migration/param_scheduler.md
|
||||
migration/runne.md
|
||||
migration/transform.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
Loading…
x
Reference in New Issue
Block a user