119 lines
2.6 KiB
ReStructuredText
119 lines
2.6 KiB
ReStructuredText
Welcome to MMEngine's documentation!
|
|
=========================================
|
|
You can switch between Chinese and English documents in the lower-left corner of the layout.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Get Started
|
|
|
|
get_started/introduction.md
|
|
get_started/installation.md
|
|
get_started/15_minutes.md
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Examples
|
|
|
|
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
|
|
|
|
tutorials/runner.md
|
|
tutorials/dataset.md
|
|
tutorials/model.md
|
|
tutorials/evaluation.md
|
|
tutorials/optim_wrapper.md
|
|
tutorials/param_scheduler.md
|
|
tutorials/hook.md
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Advanced tutorials
|
|
|
|
advanced_tutorials/registry.md
|
|
advanced_tutorials/config.md
|
|
advanced_tutorials/basedataset.md
|
|
advanced_tutorials/data_transform.md
|
|
advanced_tutorials/initialize.md
|
|
advanced_tutorials/visualization.md
|
|
advanced_tutorials/data_element.md
|
|
advanced_tutorials/distributed.md
|
|
advanced_tutorials/logging.md
|
|
advanced_tutorials/fileio.md
|
|
advanced_tutorials/manager_mixin.md
|
|
advanced_tutorials/cross_library.md
|
|
advanced_tutorials/test_time_augmentation.md
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Design
|
|
|
|
design/hook.md
|
|
design/runner.md
|
|
design/evaluation.md
|
|
design/visualization.md
|
|
design/logging.md
|
|
design/infer.md
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Migration guide
|
|
|
|
migration/runner.md
|
|
migration/hook.md
|
|
migration/model.md
|
|
migration/param_scheduler.md
|
|
migration/transform.md
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: API Reference
|
|
|
|
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.infer <api/infer>
|
|
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::
|
|
:maxdepth: 2
|
|
:caption: Notes
|
|
|
|
notes/changelog.md
|
|
notes/contributing.md
|
|
|
|
.. toctree::
|
|
:caption: Switch Language
|
|
|
|
switch_language.md
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|