mmengine/docs/en/index.rst
Mashiro a9b6753fbe
Make TTAModel compatible with FSDP (#611)
* Add build_runner_with_tta and PrepareTTAHook

* rename hook file

* support build tta runner with runner type

* add unit test

* Add build_runner_with_tta to index.rst

* minor refine

* Add runner test cast

* Fix unit test

* fix unit test

* tmp save

* pop None if key does not exist

* Fix is_model_wrapper and force register class in test_runner

* [Fix] Fix is_model_wrapper

* destroy group after ut

* register module in testcase

* pass through unit test

* fix as comment

* remove breakpoint

* remove mmengine/testing/runner_test_cast.py

* minor refine

* minor refine

* minor refine

* set default data preprocessor for model

* minor refine

* minor refine

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* fix lint

* Fix unit test

* replace  with  in ImgDataPreprocessor

* Fix as comment

* add inference tutorial in advanced tutorial

* update index.rst

* add tta example

* refine tta tutorial

* Add english tutorial

* add note for build_runner_with_tta

* Fix as comment

* add examples

* remove chinese comment

* Update docs/en/advanced_tutorials/test_time_augmentation.md

Co-authored-by: RangiLyu <lyuchqi@gmail.com>

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: RangiLyu <lyuchqi@gmail.com>
2022-12-27 21:39:43 +08:00

112 lines
2.5 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: Common Usage
examples/resume_training.md
examples/speed_up_training.md
examples/save_gpu_memory.md
examples/train_a_gan.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
.. 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.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`