mmengine/docs/zh_cn/index.rst

107 lines
2.2 KiB
ReStructuredText
Raw Normal View History

欢迎来到 mmengine 的中文文档!
=========================================
您可以在页面左下角切换中英文文档。
.. toctree::
:maxdepth: 1
:caption: 开始你的第一步
get_started/introduction.md
get_started/installation.md
get_started/15_minutes.md
.. toctree::
2022-03-06 14:36:46 +08:00
:maxdepth: 1
:caption: 教程
tutorials/registry.md
tutorials/config.md
2022-03-06 14:36:46 +08:00
tutorials/runner.md
tutorials/hook.md
tutorials/optim_wrapper.md
2022-03-06 14:36:46 +08:00
tutorials/param_scheduler.md
tutorials/evaluation.md
tutorials/data_element.md
2022-03-06 14:36:46 +08:00
tutorials/basedataset.md
tutorials/data_transform.md
2022-03-06 14:36:46 +08:00
tutorials/distributed.md
tutorials/logging.md
tutorials/visualization.md
tutorials/fileio.md
tutorials/utils.md
tutorials/model.md
tutorials/initialize.md
.. toctree::
:maxdepth: 1
:caption: 迁移指南
migration/migrate_model_from_mmcv.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/runner.md
design/metric_and_evaluator.md
design/visualization.md
design/logging.md
.. toctree::
:maxdepth: 1
:caption: 迁移指南
migration/migrate_runner_from_mmcv.md
2022-02-16 21:45:39 +08:00
.. 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>
2022-02-16 21:45:39 +08:00
.. toctree::
:caption: 语言切换
switch_language.md
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`