Skip to content
Snippets Groups Projects
index.rst 1.98 KiB
Newer Older
欢迎来到 mmengine 的中文文档!
=========================================
您可以在页面左下角切换中英文文档。

.. toctree::
   :maxdepth: 1
   :caption: 开始你的第一步

   get_started/introduction.md
   get_started/installation.md
   get_started/15_minutes.md
.. toctree::
Zaida Zhou's avatar
Zaida Zhou committed
   :maxdepth: 1
   :caption: 教程

   tutorials/registry.md
   tutorials/config.md
Zaida Zhou's avatar
Zaida Zhou committed
   tutorials/runner.md
   tutorials/hook.md
   tutorials/optim_wrapper.md
Zaida Zhou's avatar
Zaida Zhou committed
   tutorials/param_scheduler.md
   tutorials/evaluation.md
   tutorials/data_element.md
Zaida Zhou's avatar
Zaida Zhou committed
   tutorials/basedataset.md
   tutorials/distributed.md
   tutorials/logging.md
   tutorials/visualization.md
   tutorials/fileio.md
   tutorials/utils.md
.. toctree::
   :maxdepth: 1
   :caption: 示例

   examples/resume_training.md
   examples/speed_up_training.md
   examples/save_gpu_memory.md
   examples/cross_library.md

.. toctree::
   :maxdepth: 1
   :caption: 迁移指南

   migration/migrate_hook_from_mmcv.md
   migration/migrate_transform.md
   migration/migrate_param_scheduler_from_mmcv.md
.. toctree::
   :maxdepth: 1
   :caption: 架构设计

   design/hook.md
   design/metric_and_evaluator.md
   design/visualization.md
   design/logging.md
.. toctree::
   :maxdepth: 2
   :caption: API 文档

   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>
.. toctree::
   :caption: 语言切换

   switch_language.md

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`