Welcome to MMPretrain's documentation!
============================================

.. toctree::
   :maxdepth: 1
   :caption: Get Started

   get_started.md

.. toctree::
   :maxdepth: 1
   :caption: User Guides

   user_guides/config.md
   user_guides/dataset_prepare.md
   user_guides/inference.md
   user_guides/train.md
   user_guides/test.md
   user_guides/finetune.md
   user_guides/downstream.md

.. toctree::
   :maxdepth: 1
   :caption: Advanced Guides

   advanced_guides/datasets.md
   advanced_guides/pipeline.md
   advanced_guides/modules.md
   advanced_guides/schedule.md
   advanced_guides/runtime.md
   advanced_guides/evaluation.md
   advanced_guides/data_flow.md
   advanced_guides/convention.md

.. toctree::
   :maxdepth: 1
   :caption: Model Zoo
   :glob:

   modelzoo_statistics.md
   papers/*

.. 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

.. toctree::
   :maxdepth: 1
   :caption: Migration

   migration.md

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   mmpretrain.apis <api/apis>
   mmpretrain.engine <api/engine>
   mmpretrain.datasets <api/datasets>
   Data Process <api/data_process>
   mmpretrain.models <api/models>
   mmpretrain.structures <api/structures>
   mmpretrain.visualization <api/visualization>
   mmpretrain.evaluation <api/evaluation>
   mmpretrain.utils <api/utils>

.. toctree::
   :maxdepth: 1
   :caption: Notes

   notes/contribution_guide.md
   notes/projects.md
   notes/changelog.md
   notes/faq.md
   notes/pretrain_custom_dataset.md

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

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