--- a +++ b/ViTPose/docs/en/index.rst @@ -0,0 +1,99 @@ +Welcome to MMPose's documentation! +================================== + +You can change the documentation language at the lower-left corner of the page. + +您可以在页面左下角切换文档语言。 + +.. toctree:: + :maxdepth: 2 + + install.md + getting_started.md + demo.md + benchmark.md + inference_speed_summary.md + +.. toctree:: + :maxdepth: 2 + :caption: Datasets + + datasets.md + tasks/2d_body_keypoint.md + tasks/2d_wholebody_keypoint.md + tasks/2d_face_keypoint.md + tasks/2d_hand_keypoint.md + tasks/2d_fashion_landmark.md + tasks/2d_animal_keypoint.md + tasks/3d_body_keypoint.md + tasks/3d_body_mesh.md + tasks/3d_hand_keypoint.md + +.. toctree:: + :maxdepth: 2 + :caption: Model Zoo + + modelzoo.md + topics/animal.md + topics/body(2d,kpt,sview,img).md + topics/body(2d,kpt,sview,vid).md + topics/body(3d,kpt,sview,img).md + topics/body(3d,kpt,sview,vid).md + topics/body(3d,kpt,mview,img).md + topics/body(3d,mesh,sview,img).md + topics/face.md + topics/fashion.md + topics/hand(2d).md + topics/hand(3d).md + topics/wholebody.md + +.. toctree:: + :maxdepth: 2 + :caption: Model Zoo (by paper) + + papers/algorithms.md + papers/backbones.md + papers/datasets.md + papers/techniques.md + +.. toctree:: + :maxdepth: 2 + :caption: Tutorials + + tutorials/0_config.md + tutorials/1_finetune.md + tutorials/2_new_dataset.md + tutorials/3_data_pipeline.md + tutorials/4_new_modules.md + tutorials/5_export_model.md + tutorials/6_customize_runtime.md + +.. toctree:: + :maxdepth: 2 + :caption: Useful Tools and Scripts + + useful_tools.md + +.. toctree:: + :maxdepth: 2 + :caption: Notes + + changelog.md + faq.md + +.. toctree:: + :caption: API Reference + + api.rst + +.. toctree:: + :caption: Languages + + language.md + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search`