Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Move examples to a new directory #911

Merged
merged 2 commits into from Feb 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
Expand Up @@ -251,15 +251,21 @@ runner.train()
</details>

<details>
<summary>Common Usage</summary>
<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>Common Usage</summary>

- [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)

</details>

<details>
<summary>Design</summary>

Expand Down
14 changes: 10 additions & 4 deletions README_zh-CN.md
Expand Up @@ -251,15 +251,21 @@ runner.train()
</details>

<details>
<summary>常用功能</summary>
<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/train_a_gan.html)

</details>

<details>
<summary>常用功能</summary>

- [恢复训练](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)

</details>

<details>
<summary>架构设计</summary>

Expand Down
13 changes: 9 additions & 4 deletions docs/en/index.rst
Expand Up @@ -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
Expand Down
13 changes: 9 additions & 4 deletions docs/zh_cn/index.rst
Expand Up @@ -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: 入门教程
Expand Down