2022-02-12 22:14:15 +08:00
|
|
|
欢迎来到 mmengine 的中文文档！
|
|
|
|
|
=========================================
|
|
|
|
|
您可以在页面左下角切换中英文文档。
|
|
|
|
|
|
2022-08-19 10:48:45 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: 开始你的第一步
|
|
|
|
|
|
2022-08-30 16:27:20 +08:00
|
|
|
get_started/introduction.md
|
2022-08-19 10:48:45 +08:00
|
|
|
get_started/installation.md
|
2022-08-30 16:27:20 +08:00
|
|
|
get_started/15_minutes.md
|
2022-08-19 10:48:45 +08:00
|
|
|
|
2022-10-28 15:18:56 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: 常用功能
|
|
|
|
|
|
|
|
|
|
examples/resume_training.md
|
|
|
|
|
examples/speed_up_training.md
|
|
|
|
|
examples/save_gpu_memory.md
|
|
|
|
|
examples/train_a_gan.md
|
|
|
|
|
|
2022-02-15 13:12:16 +08:00
|
|
|
.. toctree::
|
2022-08-31 21:18:55 +08:00
|
|
|
:maxdepth: 3
|
|
|
|
|
:caption: 入门教程
|
2022-02-15 13:12:16 +08:00
|
|
|
|
2022-03-06 14:36:46 +08:00
|
|
|
tutorials/runner.md
|
2022-10-28 15:18:56 +08:00
|
|
|
tutorials/dataset.md
|
2022-08-31 21:18:55 +08:00
|
|
|
tutorials/model.md
|
|
|
|
|
tutorials/evaluation.md
|
2022-08-30 16:27:20 +08:00
|
|
|
tutorials/optim_wrapper.md
|
2022-03-06 14:36:46 +08:00
|
|
|
tutorials/param_scheduler.md
|
2022-10-28 15:18:56 +08:00
|
|
|
tutorials/hook.md
|
2022-08-31 21:18:55 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: 进阶教程
|
|
|
|
|
|
2022-10-28 15:18:56 +08:00
|
|
|
advanced_tutorials/registry.md
|
|
|
|
|
advanced_tutorials/config.md
|
2022-08-31 21:18:55 +08:00
|
|
|
advanced_tutorials/basedataset.md
|
2022-10-28 15:18:56 +08:00
|
|
|
advanced_tutorials/data_transform.md
|
2022-08-31 21:18:55 +08:00
|
|
|
advanced_tutorials/initialize.md
|
2022-10-28 15:18:56 +08:00
|
|
|
advanced_tutorials/visualization.md
|
|
|
|
|
advanced_tutorials/data_element.md
|
2022-08-31 21:18:55 +08:00
|
|
|
advanced_tutorials/distributed.md
|
|
|
|
|
advanced_tutorials/logging.md
|
|
|
|
|
advanced_tutorials/fileio.md
|
2022-11-18 15:23:48 +08:00
|
|
|
advanced_tutorials/manager_mixin.md
|
2022-10-28 15:18:56 +08:00
|
|
|
advanced_tutorials/cross_library.md
|
2022-08-30 15:07:06 +08:00
|
|
|
|
2022-08-23 16:20:47 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: 架构设计
|
|
|
|
|
|
|
|
|
|
design/hook.md
|
2022-08-30 15:07:06 +08:00
|
|
|
design/runner.md
|
2022-08-31 21:18:55 +08:00
|
|
|
design/evaluation.md
|
2022-08-30 15:07:06 +08:00
|
|
|
design/visualization.md
|
2022-08-30 16:22:15 +08:00
|
|
|
design/logging.md
|
2022-08-23 16:20:47 +08:00
|
|
|
|
2022-08-30 21:31:02 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: 迁移指南
|
|
|
|
|
|
2022-09-01 11:34:03 +08:00
|
|
|
migration/runner.md
|
2022-08-31 21:18:55 +08:00
|
|
|
migration/hook.md
|
2022-09-01 11:34:03 +08:00
|
|
|
migration/model.md
|
2022-08-31 21:18:55 +08:00
|
|
|
migration/param_scheduler.md
|
2022-09-01 11:34:03 +08:00
|
|
|
migration/transform.md
|
2022-08-30 21:31:02 +08:00
|
|
|
|
2022-02-16 21:45:39 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: API 文档
|
|
|
|
|
|
2022-08-30 16:27:20 +08:00
|
|
|
mmengine.registry <api/registry>
|
|
|
|
|
mmengine.config <api/config>
|
|
|
|
|
mmengine.runner <api/runner>
|
|
|
|
|
mmengine.hooks <api/hooks>
|
|
|
|
|
mmengine.model <api/model>
|
|
|
|
|
mmengine.optim <api/optim>
|
|
|
|
|
mmengine.evaluator <api/evaluator>
|
|
|
|
|
mmengine.structures <api/structures>
|
|
|
|
|
mmengine.dataset <api/dataset>
|
|
|
|
|
mmengine.device <api/device>
|
|
|
|
|
mmengine.hub <api/hub>
|
|
|
|
|
mmengine.logging <api/logging>
|
|
|
|
|
mmengine.visualization <api/visualization>
|
|
|
|
|
mmengine.fileio <api/fileio>
|
|
|
|
|
mmengine.dist <api/dist>
|
|
|
|
|
mmengine.utils <api/utils>
|
|
|
|
|
mmengine.utils.dl_utils <api/utils.dl_utils>
|
2022-02-16 21:45:39 +08:00
|
|
|
|
2022-10-11 23:08:17 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
2022-10-14 16:56:34 +08:00
|
|
|
:caption: 说明
|
2022-10-11 23:08:17 +08:00
|
|
|
|
|
|
|
|
notes/changelog.md
|
2022-12-04 10:52:11 +08:00
|
|
|
notes/contributing.md
|
|
|
|
|
notes/code_style.md
|
2022-10-11 23:08:17 +08:00
|
|
|
|
2022-02-12 22:14:15 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:caption: 语言切换
|
|
|
|
|
|
|
|
|
|
switch_language.md
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
