2023-03-02 13:29:07 +08:00
|
|
|
Welcome to MMPretrain's documentation!
|
2021-07-14 15:06:50 +08:00
|
|
|
============================================
|
2020-07-10 17:06:36 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2021-09-23 22:21:03 +08:00
|
|
|
:maxdepth: 1
|
2020-12-28 19:47:06 +08:00
|
|
|
:caption: Get Started
|
2020-07-10 17:06:36 +08:00
|
|
|
|
2022-08-24 16:00:36 +08:00
|
|
|
get_started.md
|
2020-12-28 19:47:06 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2021-09-23 22:21:03 +08:00
|
|
|
:maxdepth: 1
|
2022-08-24 16:00:36 +08:00
|
|
|
:caption: User Guides
|
|
|
|
|
|
|
|
|
|
user_guides/config.md
|
2023-03-20 15:56:09 +08:00
|
|
|
user_guides/dataset_prepare.md
|
|
|
|
|
user_guides/inference.md
|
|
|
|
|
user_guides/train.md
|
|
|
|
|
user_guides/test.md
|
|
|
|
|
user_guides/downstream.md
|
2020-12-28 19:47:06 +08:00
|
|
|
|
2022-08-24 16:00:36 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Advanced Guides
|
2020-07-10 17:06:36 +08:00
|
|
|
|
2022-08-24 16:00:36 +08:00
|
|
|
advanced_guides/datasets.md
|
|
|
|
|
advanced_guides/pipeline.md
|
|
|
|
|
advanced_guides/modules.md
|
|
|
|
|
advanced_guides/schedule.md
|
2022-11-02 10:59:59 +08:00
|
|
|
advanced_guides/runtime.md
|
2022-08-24 16:00:36 +08:00
|
|
|
advanced_guides/evaluation.md
|
2022-08-29 11:10:05 +08:00
|
|
|
advanced_guides/convention.md
|
2020-07-10 17:06:36 +08:00
|
|
|
|
2022-01-26 18:26:01 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2023-03-20 15:56:09 +08:00
|
|
|
:caption: Model Zoo
|
2022-01-26 18:26:01 +08:00
|
|
|
:glob:
|
|
|
|
|
|
|
|
|
|
modelzoo_statistics.md
|
|
|
|
|
papers/*
|
2021-10-14 15:26:47 +08:00
|
|
|
|
2023-03-20 15:56:09 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Visualization
|
|
|
|
|
|
|
|
|
|
useful_tools/dataset_visualization.md
|
|
|
|
|
useful_tools/scheduler_visualization.md
|
|
|
|
|
useful_tools/cam_visualization.md
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Analysis Tools
|
|
|
|
|
|
|
|
|
|
useful_tools/print_config.md
|
|
|
|
|
useful_tools/verify_dataset.md
|
|
|
|
|
useful_tools/log_result_analysis.md
|
|
|
|
|
useful_tools/complexity_analysis.md
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Deployment
|
|
|
|
|
|
|
|
|
|
useful_tools/model_serving.md
|
|
|
|
|
|
2021-09-28 18:05:50 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2022-08-24 16:00:36 +08:00
|
|
|
:caption: Migration
|
2021-09-28 18:05:50 +08:00
|
|
|
|
2022-08-24 16:00:36 +08:00
|
|
|
migration.md
|
2021-09-28 18:05:50 +08:00
|
|
|
|
2021-07-14 15:06:50 +08:00
|
|
|
.. toctree::
|
2022-04-15 20:19:20 +08:00
|
|
|
:maxdepth: 1
|
2021-07-14 15:06:50 +08:00
|
|
|
:caption: API Reference
|
|
|
|
|
|
2023-03-02 13:29:07 +08:00
|
|
|
mmpretrain.apis <api/apis>
|
|
|
|
|
mmpretrain.engine <api/engine>
|
|
|
|
|
mmpretrain.datasets <api/datasets>
|
2022-08-24 16:00:36 +08:00
|
|
|
Data Process <api/data_process>
|
2023-03-02 13:29:07 +08:00
|
|
|
mmpretrain.models <api/models>
|
|
|
|
|
mmpretrain.structures <api/structures>
|
|
|
|
|
mmpretrain.visualization <api/visualization>
|
|
|
|
|
mmpretrain.evaluation <api/evaluation>
|
|
|
|
|
mmpretrain.utils <api/utils>
|
2021-07-14 15:06:50 +08:00
|
|
|
|
2022-01-26 18:26:01 +08:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2022-06-01 18:31:57 +08:00
|
|
|
:caption: Notes
|
2022-01-26 18:26:01 +08:00
|
|
|
|
2022-08-24 16:00:36 +08:00
|
|
|
notes/contribution_guide.md
|
|
|
|
|
notes/projects.md
|
|
|
|
|
notes/changelog.md
|
|
|
|
|
notes/faq.md
|
2023-03-20 15:56:09 +08:00
|
|
|
notes/pretrain_custom_dataset.md
|
2023-03-27 14:32:26 +08:00
|
|
|
notes/finetune_custom_dataset.md
|
2020-12-28 19:47:06 +08:00
|
|
|
|
2020-07-10 17:06:36 +08:00
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`search`
|
