mmpretrain/docs/en/index.rst

89 lines
1.8 KiB
ReStructuredText

Welcome to MMClassification's documentation!
============================================
You can switch between Chinese and English documentation in the lower-left corner of the layout.
您可以在页面左下角切换中英文文档。
.. toctree::
:maxdepth: 1
:caption: Get Started
get_started.md
.. toctree::
:maxdepth: 1
:caption: User Guides
user_guides/inference.md
user_guides/dataset_prepare.md
user_guides/train_test.md
user_guides/config.md
user_guides/finetune.md
user_guides/analysis.md
user_guides/visualization.md
user_guides/useful_tools.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: Migration
migration.md
.. toctree::
:maxdepth: 1
:caption: API Reference
mmcls.apis <api/apis>
mmcls.engine <api/engine>
mmcls.datasets <api/datasets>
Data Process <api/data_process>
mmcls.models <api/models>
mmcls.structures <api/structures>
mmcls.visualization <api/visualization>
mmcls.evaluation <api/evaluation>
mmcls.utils <api/utils>
.. toctree::
:maxdepth: 1
:caption: Notes
notes/contribution_guide.md
notes/projects.md
notes/changelog.md
notes/faq.md
.. toctree::
:caption: Switch Language
English <https://mmclassification.readthedocs.io/en/1.x/>
简体中文 <https://mmclassification.readthedocs.io/zh_CN/1.x/>
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`