Skip to content

Commit 4749682

Browse files
authored
[Docs] Move examples to a new directory (#911)
* [Docs] Move examples to a new directory * fix typo
1 parent e35ed5f commit 4749682

File tree

10 files changed

+38
-16
lines changed

10 files changed

+38
-16
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -251,15 +251,21 @@ runner.train()
251251
</details>
252252

253253
<details>
254-
<summary>Common Usage</summary>
254+
<summary>Examples</summary>
255255

256-
- [Resume Training](https://mmengine.readthedocs.io/en/latest/examples/resume_training.html)
257-
- [Speed up Training](https://mmengine.readthedocs.io/en/latest/examples/speed_up_training.html)
258-
- [Save Memory on GPU](https://mmengine.readthedocs.io/en/latest/examples/save_gpu_memory.html)
259256
- [Train a GAN](https://mmengine.readthedocs.io/en/latest/examples/train_a_gan.html)
260257

261258
</details>
262259

260+
<details>
261+
<summary>Common Usage</summary>
262+
263+
- [Resume Training](https://mmengine.readthedocs.io/en/latest/common_usage/resume_training.html)
264+
- [Speed up Training](https://mmengine.readthedocs.io/en/latest/common_usage/speed_up_training.html)
265+
- [Save Memory on GPU](https://mmengine.readthedocs.io/en/latest/common_usage/save_gpu_memory.html)
266+
267+
</details>
268+
263269
<details>
264270
<summary>Design</summary>
265271

README_zh-CN.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -251,15 +251,21 @@ runner.train()
251251
</details>
252252

253253
<details>
254-
<summary>常用功能</summary>
254+
<summary>示例</summary>
255255

256-
- [恢复训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/resume_training.html)
257-
- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/examples/speed_up_training.html)
258-
- [节省显存](https://mmengine.readthedocs.io/zh_CN/latest/examples/save_gpu_memory.html)
259256
- [训练生成对抗网络](https://mmengine.readthedocs.io/zh_CN/latest/examples/train_a_gan.html)
260257

261258
</details>
262259

260+
<details>
261+
<summary>常用功能</summary>
262+
263+
- [恢复训练](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/resume_training.html)
264+
- [加速训练](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/speed_up_training.html)
265+
- [节省显存](https://mmengine.readthedocs.io/zh_CN/latest/common_usage/save_gpu_memory.html)
266+
267+
</details>
268+
263269
<details>
264270
<summary>架构设计</summary>
265271

File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/en/index.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ You can switch between Chinese and English documents in the lower-left corner of
1212

1313
.. toctree::
1414
:maxdepth: 1
15-
:caption: Common Usage
15+
:caption: Examples
1616

17-
examples/resume_training.md
18-
examples/speed_up_training.md
19-
examples/save_gpu_memory.md
2017
examples/train_a_gan.md
2118

19+
.. toctree::
20+
:maxdepth: 1
21+
:caption: Common Usage
22+
23+
common_usage/resume_training.md
24+
common_usage/speed_up_training.md
25+
common_usage/save_gpu_memory.md
26+
2227
.. toctree::
2328
:maxdepth: 3
2429
:caption: Tutorials
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/zh_cn/index.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@
1212

1313
.. toctree::
1414
:maxdepth: 1
15-
:caption: 常用功能
15+
:caption: 示例
1616

17-
examples/resume_training.md
18-
examples/speed_up_training.md
19-
examples/save_gpu_memory.md
2017
examples/train_a_gan.md
2118

19+
.. toctree::
20+
:maxdepth: 1
21+
:caption: 常用功能
22+
23+
common_usage/resume_training.md
24+
common_usage/speed_up_training.md
25+
common_usage/save_gpu_memory.md
26+
2227
.. toctree::
2328
:maxdepth: 3
2429
:caption: 入门教程

0 commit comments

Comments
 (0)