mmpose/docs/en/index.rst

119 lines
2.3 KiB
ReStructuredText

Welcome to MMPose's documentation!
==================================
You can change the documentation language at the lower-left corner of the page.
您可以在页面左下角切换文档语言。
.. toctree::
:maxdepth: 1
:caption: Get Started
overview.md
installation.md
guide_to_framework.md
demos.md
contribution_guide.md
faq.md
.. toctree::
:maxdepth: 1
:caption: User Guides
user_guides/inference.md
user_guides/configs.md
user_guides/prepare_datasets.md
user_guides/train_and_test.md
user_guides/how_to_deploy.md
user_guides/model_analysis.md
user_guides/dataset_tools.md
.. toctree::
:maxdepth: 1
:caption: Advanced Guides
advanced_guides/codecs.md
advanced_guides/dataflow.md
advanced_guides/implement_new_models.md
advanced_guides/customize_datasets.md
advanced_guides/customize_transforms.md
advanced_guides/customize_evaluation.md
advanced_guides/customize_optimizer.md
advanced_guides/customize_logging.md
.. toctree::
:maxdepth: 1
:caption: Migration
migration.md
.. toctree::
:maxdepth: 2
:caption: Model Zoo
model_zoo.txt
model_zoo/body_2d_keypoint.md
model_zoo/body_3d_keypoint.md
model_zoo/face_2d_keypoint.md
model_zoo/hand_2d_keypoint.md
model_zoo/wholebody_2d_keypoint.md
model_zoo/animal_2d_keypoint.md
.. toctree::
:maxdepth: 2
:caption: Model Zoo (by paper)
model_zoo_papers/algorithms.md
model_zoo_papers/backbones.md
model_zoo_papers/techniques.md
model_zoo_papers/datasets.md
.. toctree::
:maxdepth: 2
:caption: Dataset Zoo
dataset_zoo.md
dataset_zoo/2d_body_keypoint.md
dataset_zoo/2d_wholebody_keypoint.md
dataset_zoo/2d_face_keypoint.md
dataset_zoo/2d_hand_keypoint.md
dataset_zoo/2d_fashion_landmark.md
dataset_zoo/2d_animal_keypoint.md
dataset_zoo/3d_body_keypoint.md
dataset_zoo/3d_hand_keypoint.md
dataset_zoo/3d_wholebody_keypoint.md
.. toctree::
:maxdepth: 1
:caption: Projects
projects/community_projects.md
projects/projects.md
.. toctree::
:maxdepth: 1
:caption: Notes
notes/ecosystem.md
notes/changelog.md
notes/benchmark.md
notes/pytorch_2.md
.. toctree::
:caption: API Reference
api.rst
.. toctree::
:caption: Switch Language
switch_language.md
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`