From 93c3a742c540dfb4ca515ad545cef705a07d90b4 Mon Sep 17 00:00:00 2001 From: Yining Li Date: Fri, 17 Dec 2021 10:52:44 +0800 Subject: [PATCH] [Doc] Merge doc folder (#1083) * merge folders of en/zh_cn docs * fix merge_docs.sh * fix index.rst * fix merge_docs.sh * use shared menu * fix merge_docs * fix zh_cn doc link --- .github/workflows/build.yml | 2 - .gitignore | 16 +- .pre-commit-config.yaml | 2 +- README.md | 30 +-- README_CN.md | 32 +-- configs/animal/2d_kpt_sview_rgb_img/README.md | 4 +- configs/body/2d_kpt_sview_rgb_img/README.md | 4 +- configs/body/2d_kpt_sview_rgb_vid/README.md | 2 +- .../hrnet_posetrack18_posewarper.md | 2 +- configs/body/3d_kpt_sview_rgb_img/README.md | 4 +- configs/body/3d_kpt_sview_rgb_vid/README.md | 2 +- configs/body/3d_mesh_sview_rgb_img/README.md | 2 +- configs/face/2d_kpt_sview_rgb_img/README.md | 4 +- .../fashion/2d_kpt_sview_rgb_img/README.md | 2 +- configs/hand/2d_kpt_sview_rgb_img/README.md | 4 +- configs/hand/3d_kpt_sview_rgb_img/README.md | 2 +- .../wholebody/2d_kpt_sview_rgb_img/README.md | 4 +- demo/docs/2d_pose_tracking_demo.md | 2 +- docs/conf.py | 214 ------------------ docs/{ => en}/Makefile | 0 docs/{ => en}/_static/css/readthedocs.css | 0 docs/{ => en}/_static/images/mmpose-logo.png | Bin docs/{ => en}/api.rst | 0 docs/{ => en}/benchmark.md | 0 docs/{ => en}/changelog.md | 4 +- docs/{ => en}/collect.py | 10 +- docs/en/conf.py | 116 ++++++++++ docs/{ => en}/data_preparation.md | 0 docs/{ => en}/faq.md | 16 +- docs/{ => en}/getting_started.md | 20 +- docs/{ => en}/imgs/acc_curve.png | Bin docs/{ => en}/imgs/qq_group2_qrcode.jpg | Bin docs/{ => en}/imgs/qq_group_qrcode.jpg | Bin docs/{ => en}/imgs/zhihu_qrcode.jpg | Bin docs/{ => en}/index.rst | 1 + docs/{ => en}/inference_speed_summary.md | 0 docs/{ => en}/install.md | 0 docs/{ => en}/language.md | 0 docs/{ => en}/make.bat | 0 docs/{ => en}/merge_docs.sh | 24 +- .../algorithms/associative_embedding.md | 0 docs/{ => en}/papers/algorithms/cpm.md | 0 docs/{ => en}/papers/algorithms/dark.md | 0 docs/{ => en}/papers/algorithms/deeppose.md | 0 .../{ => en}/papers/algorithms/higherhrnet.md | 0 docs/{ => en}/papers/algorithms/hmr.md | 0 docs/{ => en}/papers/algorithms/hourglass.md | 0 docs/{ => en}/papers/algorithms/hrnet.md | 0 docs/{ => en}/papers/algorithms/hrnetv2.md | 0 docs/{ => en}/papers/algorithms/internet.md | 0 docs/{ => en}/papers/algorithms/litehrnet.md | 0 docs/{ => en}/papers/algorithms/mspn.md | 0 docs/{ => en}/papers/algorithms/posewarper.md | 0 docs/{ => en}/papers/algorithms/rsn.md | 0 docs/{ => en}/papers/algorithms/scnet.md | 0 .../papers/algorithms/simplebaseline2d.md | 0 .../papers/algorithms/simplebaseline3d.md | 0 docs/{ => en}/papers/algorithms/udp.md | 0 .../{ => en}/papers/algorithms/videopose3d.md | 0 docs/{ => en}/papers/algorithms/vipnas.md | 0 docs/{ => en}/papers/algorithms/wingloss.md | 0 docs/{ => en}/papers/backbones/alexnet.md | 0 docs/{ => en}/papers/backbones/cpm.md | 0 docs/{ => en}/papers/backbones/higherhrnet.md | 0 docs/{ => en}/papers/backbones/hourglass.md | 0 docs/{ => en}/papers/backbones/hrnet.md | 0 docs/{ => en}/papers/backbones/hrnetv2.md | 0 docs/{ => en}/papers/backbones/litehrnet.md | 0 docs/{ => en}/papers/backbones/mobilenetv2.md | 0 docs/{ => en}/papers/backbones/mspn.md | 0 docs/{ => en}/papers/backbones/resnest.md | 0 docs/{ => en}/papers/backbones/resnet.md | 0 docs/{ => en}/papers/backbones/resnetv1d.md | 0 docs/{ => en}/papers/backbones/resnext.md | 0 docs/{ => en}/papers/backbones/rsn.md | 0 docs/{ => en}/papers/backbones/scnet.md | 0 docs/{ => en}/papers/backbones/seresnet.md | 0 .../{ => en}/papers/backbones/shufflenetv1.md | 0 .../{ => en}/papers/backbones/shufflenetv2.md | 0 docs/{ => en}/papers/backbones/vgg.md | 0 docs/{ => en}/papers/backbones/vipnas.md | 0 docs/{ => en}/papers/datasets/300w.md | 0 docs/{ => en}/papers/datasets/aflw.md | 0 docs/{ => en}/papers/datasets/aic.md | 0 docs/{ => en}/papers/datasets/animalpose.md | 0 docs/{ => en}/papers/datasets/ap10k.md | 0 docs/{ => en}/papers/datasets/atrw.md | 0 docs/{ => en}/papers/datasets/coco.md | 0 .../papers/datasets/coco_wholebody.md | 0 .../papers/datasets/coco_wholebody_face.md | 0 .../papers/datasets/coco_wholebody_hand.md | 0 docs/{ => en}/papers/datasets/cofw.md | 0 docs/{ => en}/papers/datasets/crowdpose.md | 0 docs/{ => en}/papers/datasets/deepfashion.md | 0 docs/{ => en}/papers/datasets/fly.md | 0 docs/{ => en}/papers/datasets/freihand.md | 0 docs/{ => en}/papers/datasets/h36m.md | 0 docs/{ => en}/papers/datasets/halpe.md | 0 docs/{ => en}/papers/datasets/horse10.md | 0 docs/{ => en}/papers/datasets/interhand.md | 0 docs/{ => en}/papers/datasets/jhmdb.md | 0 docs/{ => en}/papers/datasets/locust.md | 0 docs/{ => en}/papers/datasets/macaque.md | 0 docs/{ => en}/papers/datasets/mhp.md | 0 docs/{ => en}/papers/datasets/mpi_inf_3dhp.md | 0 docs/{ => en}/papers/datasets/mpii.md | 0 docs/{ => en}/papers/datasets/mpii_trb.md | 0 docs/{ => en}/papers/datasets/ochuman.md | 0 docs/{ => en}/papers/datasets/onehand10k.md | 0 docs/{ => en}/papers/datasets/panoptic.md | 0 docs/{ => en}/papers/datasets/posetrack18.md | 0 docs/{ => en}/papers/datasets/rhd.md | 0 docs/{ => en}/papers/datasets/wflw.md | 0 docs/{ => en}/papers/datasets/zebra.md | 0 .../papers/techniques/albumentations.md | 0 docs/{ => en}/papers/techniques/dark.md | 0 docs/{ => en}/papers/techniques/fp16.md | 0 docs/{ => en}/papers/techniques/udp.md | 0 docs/{ => en}/papers/techniques/wingloss.md | 0 docs/{ => en}/stats.py | 0 docs/{ => en}/tasks/2d_animal_keypoint.md | 0 docs/{ => en}/tasks/2d_body_keypoint.md | 0 docs/{ => en}/tasks/2d_face_keypoint.md | 0 docs/{ => en}/tasks/2d_fashion_landmark.md | 0 docs/{ => en}/tasks/2d_hand_keypoint.md | 0 docs/{ => en}/tasks/2d_wholebody_keypoint.md | 0 docs/{ => en}/tasks/3d_body_keypoint.md | 2 +- docs/{ => en}/tasks/3d_body_mesh.md | 0 docs/{ => en}/tasks/3d_hand_keypoint.md | 0 docs/{ => en}/tutorials/0_config.md | 0 docs/{ => en}/tutorials/1_finetune.md | 0 docs/{ => en}/tutorials/2_new_dataset.md | 0 docs/{ => en}/tutorials/3_data_pipeline.md | 0 docs/{ => en}/tutorials/4_new_modules.md | 0 docs/{ => en}/tutorials/5_export_model.md | 0 .../{ => en}/tutorials/6_customize_runtime.md | 0 docs/{ => en}/useful_tools.md | 0 {docs_zh-CN => docs/zh_cn}/Makefile | 0 .../zh_cn}/_static/css/readthedocs.css | 0 .../zh_cn}/_static/images/mmpose-logo.png | Bin {docs_zh-CN => docs/zh_cn}/api.rst | 0 {docs_zh-CN => docs/zh_cn}/benchmark.md | 0 {docs_zh-CN => docs/zh_cn}/collect.py | 10 +- docs/zh_cn/conf.py | 112 +++++++++ .../zh_cn}/data_preparation.md | 0 {docs_zh-CN => docs/zh_cn}/faq.md | 0 {docs_zh-CN => docs/zh_cn}/getting_started.md | 20 +- {docs_zh-CN => docs/zh_cn}/imgs/acc_curve.png | Bin .../zh_cn}/imgs/qq_group_qrcode.jpg | Bin .../zh_cn}/imgs/zhihu_qrcode.jpg | Bin {docs_zh-CN => docs/zh_cn}/index.rst | 1 + .../zh_cn}/inference_speed_summary.md | 0 {docs_zh-CN => docs/zh_cn}/install.md | 0 {docs_zh-CN => docs/zh_cn}/language.md | 0 {docs_zh-CN => docs/zh_cn}/make.bat | 0 {docs_zh-CN => docs/zh_cn}/merge_docs.sh | 24 +- {docs_zh-CN => docs/zh_cn}/stats.py | 0 .../zh_cn}/tasks/2d_animal_keypoint.md | 0 .../zh_cn}/tasks/2d_body_keypoint.md | 0 .../zh_cn}/tasks/2d_face_keypoint.md | 0 .../zh_cn}/tasks/2d_fashion_landmark.md | 0 .../zh_cn}/tasks/2d_hand_keypoint.md | 0 .../zh_cn}/tasks/2d_wholebody_keypoint.md | 0 .../zh_cn}/tasks/3d_body_keypoint.md | 0 .../zh_cn}/tasks/3d_body_mesh.md | 0 .../zh_cn}/tasks/3d_hand_keypoint.md | 0 .../zh_cn}/tutorials/0_config.md | 0 .../zh_cn}/tutorials/1_finetune.md | 0 .../zh_cn}/tutorials/2_new_dataset.md | 0 .../zh_cn}/tutorials/3_data_pipeline.md | 0 .../zh_cn}/tutorials/4_new_modules.md | 0 .../zh_cn}/tutorials/5_export_model.md | 0 .../zh_cn}/tutorials/6_customize_runtime.md | 0 {docs_zh-CN => docs/zh_cn}/useful_tools.md | 0 docs_zh-CN/conf.py | 187 --------------- 175 files changed, 345 insertions(+), 536 deletions(-) delete mode 100644 docs/conf.py rename docs/{ => en}/Makefile (100%) rename docs/{ => en}/_static/css/readthedocs.css (100%) rename docs/{ => en}/_static/images/mmpose-logo.png (100%) rename docs/{ => en}/api.rst (100%) rename docs/{ => en}/benchmark.md (100%) rename docs/{ => en}/changelog.md (98%) rename docs/{ => en}/collect.py (90%) create mode 100644 docs/en/conf.py rename docs/{ => en}/data_preparation.md (100%) rename docs/{ => en}/faq.md (80%) rename docs/{ => en}/getting_started.md (94%) rename docs/{ => en}/imgs/acc_curve.png (100%) rename docs/{ => en}/imgs/qq_group2_qrcode.jpg (100%) rename docs/{ => en}/imgs/qq_group_qrcode.jpg (100%) rename docs/{ => en}/imgs/zhihu_qrcode.jpg (100%) rename docs/{ => en}/index.rst (98%) rename docs/{ => en}/inference_speed_summary.md (100%) rename docs/{ => en}/install.md (100%) rename docs/{ => en}/language.md (100%) rename docs/{ => en}/make.bat (100%) rename docs/{ => en}/merge_docs.sh (58%) rename docs/{ => en}/papers/algorithms/associative_embedding.md (100%) rename docs/{ => en}/papers/algorithms/cpm.md (100%) rename docs/{ => en}/papers/algorithms/dark.md (100%) rename docs/{ => en}/papers/algorithms/deeppose.md (100%) rename docs/{ => en}/papers/algorithms/higherhrnet.md (100%) rename docs/{ => en}/papers/algorithms/hmr.md (100%) rename docs/{ => en}/papers/algorithms/hourglass.md (100%) rename docs/{ => en}/papers/algorithms/hrnet.md (100%) rename docs/{ => en}/papers/algorithms/hrnetv2.md (100%) rename docs/{ => en}/papers/algorithms/internet.md (100%) rename docs/{ => en}/papers/algorithms/litehrnet.md (100%) rename docs/{ => en}/papers/algorithms/mspn.md (100%) rename docs/{ => en}/papers/algorithms/posewarper.md (100%) rename docs/{ => en}/papers/algorithms/rsn.md (100%) rename docs/{ => en}/papers/algorithms/scnet.md (100%) rename docs/{ => en}/papers/algorithms/simplebaseline2d.md (100%) rename docs/{ => en}/papers/algorithms/simplebaseline3d.md (100%) rename docs/{ => en}/papers/algorithms/udp.md (100%) rename docs/{ => en}/papers/algorithms/videopose3d.md (100%) rename docs/{ => en}/papers/algorithms/vipnas.md (100%) rename docs/{ => en}/papers/algorithms/wingloss.md (100%) rename docs/{ => en}/papers/backbones/alexnet.md (100%) rename docs/{ => en}/papers/backbones/cpm.md (100%) rename docs/{ => en}/papers/backbones/higherhrnet.md (100%) rename docs/{ => en}/papers/backbones/hourglass.md (100%) rename docs/{ => en}/papers/backbones/hrnet.md (100%) rename docs/{ => en}/papers/backbones/hrnetv2.md (100%) rename docs/{ => en}/papers/backbones/litehrnet.md (100%) rename docs/{ => en}/papers/backbones/mobilenetv2.md (100%) rename docs/{ => en}/papers/backbones/mspn.md (100%) rename docs/{ => en}/papers/backbones/resnest.md (100%) rename docs/{ => en}/papers/backbones/resnet.md (100%) rename docs/{ => en}/papers/backbones/resnetv1d.md (100%) rename docs/{ => en}/papers/backbones/resnext.md (100%) rename docs/{ => en}/papers/backbones/rsn.md (100%) rename docs/{ => en}/papers/backbones/scnet.md (100%) rename docs/{ => en}/papers/backbones/seresnet.md (100%) rename docs/{ => en}/papers/backbones/shufflenetv1.md (100%) rename docs/{ => en}/papers/backbones/shufflenetv2.md (100%) rename docs/{ => en}/papers/backbones/vgg.md (100%) rename docs/{ => en}/papers/backbones/vipnas.md (100%) rename docs/{ => en}/papers/datasets/300w.md (100%) rename docs/{ => en}/papers/datasets/aflw.md (100%) rename docs/{ => en}/papers/datasets/aic.md (100%) rename docs/{ => en}/papers/datasets/animalpose.md (100%) rename docs/{ => en}/papers/datasets/ap10k.md (100%) rename docs/{ => en}/papers/datasets/atrw.md (100%) rename docs/{ => en}/papers/datasets/coco.md (100%) rename docs/{ => en}/papers/datasets/coco_wholebody.md (100%) rename docs/{ => en}/papers/datasets/coco_wholebody_face.md (100%) rename docs/{ => en}/papers/datasets/coco_wholebody_hand.md (100%) rename docs/{ => en}/papers/datasets/cofw.md (100%) rename docs/{ => en}/papers/datasets/crowdpose.md (100%) rename docs/{ => en}/papers/datasets/deepfashion.md (100%) rename docs/{ => en}/papers/datasets/fly.md (100%) rename docs/{ => en}/papers/datasets/freihand.md (100%) rename docs/{ => en}/papers/datasets/h36m.md (100%) rename docs/{ => en}/papers/datasets/halpe.md (100%) rename docs/{ => en}/papers/datasets/horse10.md (100%) rename docs/{ => en}/papers/datasets/interhand.md (100%) rename docs/{ => en}/papers/datasets/jhmdb.md (100%) rename docs/{ => en}/papers/datasets/locust.md (100%) rename docs/{ => en}/papers/datasets/macaque.md (100%) rename docs/{ => en}/papers/datasets/mhp.md (100%) rename docs/{ => en}/papers/datasets/mpi_inf_3dhp.md (100%) rename docs/{ => en}/papers/datasets/mpii.md (100%) rename docs/{ => en}/papers/datasets/mpii_trb.md (100%) rename docs/{ => en}/papers/datasets/ochuman.md (100%) rename docs/{ => en}/papers/datasets/onehand10k.md (100%) rename docs/{ => en}/papers/datasets/panoptic.md (100%) rename docs/{ => en}/papers/datasets/posetrack18.md (100%) rename docs/{ => en}/papers/datasets/rhd.md (100%) rename docs/{ => en}/papers/datasets/wflw.md (100%) rename docs/{ => en}/papers/datasets/zebra.md (100%) rename docs/{ => en}/papers/techniques/albumentations.md (100%) rename docs/{ => en}/papers/techniques/dark.md (100%) rename docs/{ => en}/papers/techniques/fp16.md (100%) rename docs/{ => en}/papers/techniques/udp.md (100%) rename docs/{ => en}/papers/techniques/wingloss.md (100%) rename docs/{ => en}/stats.py (100%) rename docs/{ => en}/tasks/2d_animal_keypoint.md (100%) rename docs/{ => en}/tasks/2d_body_keypoint.md (100%) rename docs/{ => en}/tasks/2d_face_keypoint.md (100%) rename docs/{ => en}/tasks/2d_fashion_landmark.md (100%) rename docs/{ => en}/tasks/2d_hand_keypoint.md (100%) rename docs/{ => en}/tasks/2d_wholebody_keypoint.md (100%) rename docs/{ => en}/tasks/3d_body_keypoint.md (95%) rename docs/{ => en}/tasks/3d_body_mesh.md (100%) rename docs/{ => en}/tasks/3d_hand_keypoint.md (100%) rename docs/{ => en}/tutorials/0_config.md (100%) rename docs/{ => en}/tutorials/1_finetune.md (100%) rename docs/{ => en}/tutorials/2_new_dataset.md (100%) rename docs/{ => en}/tutorials/3_data_pipeline.md (100%) rename docs/{ => en}/tutorials/4_new_modules.md (100%) rename docs/{ => en}/tutorials/5_export_model.md (100%) rename docs/{ => en}/tutorials/6_customize_runtime.md (100%) rename docs/{ => en}/useful_tools.md (100%) rename {docs_zh-CN => docs/zh_cn}/Makefile (100%) rename {docs_zh-CN => docs/zh_cn}/_static/css/readthedocs.css (100%) rename {docs_zh-CN => docs/zh_cn}/_static/images/mmpose-logo.png (100%) rename {docs_zh-CN => docs/zh_cn}/api.rst (100%) rename {docs_zh-CN => docs/zh_cn}/benchmark.md (100%) rename {docs_zh-CN => docs/zh_cn}/collect.py (90%) create mode 100644 docs/zh_cn/conf.py rename {docs_zh-CN => docs/zh_cn}/data_preparation.md (100%) rename {docs_zh-CN => docs/zh_cn}/faq.md (100%) rename {docs_zh-CN => docs/zh_cn}/getting_started.md (93%) rename {docs_zh-CN => docs/zh_cn}/imgs/acc_curve.png (100%) rename {docs_zh-CN => docs/zh_cn}/imgs/qq_group_qrcode.jpg (100%) rename {docs_zh-CN => docs/zh_cn}/imgs/zhihu_qrcode.jpg (100%) rename {docs_zh-CN => docs/zh_cn}/index.rst (98%) rename {docs_zh-CN => docs/zh_cn}/inference_speed_summary.md (100%) rename {docs_zh-CN => docs/zh_cn}/install.md (100%) rename {docs_zh-CN => docs/zh_cn}/language.md (100%) rename {docs_zh-CN => docs/zh_cn}/make.bat (100%) rename {docs_zh-CN => docs/zh_cn}/merge_docs.sh (57%) rename {docs_zh-CN => docs/zh_cn}/stats.py (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/2d_animal_keypoint.md (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/2d_body_keypoint.md (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/2d_face_keypoint.md (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/2d_fashion_landmark.md (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/2d_hand_keypoint.md (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/2d_wholebody_keypoint.md (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/3d_body_keypoint.md (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/3d_body_mesh.md (100%) rename {docs_zh-CN => docs/zh_cn}/tasks/3d_hand_keypoint.md (100%) rename {docs_zh-CN => docs/zh_cn}/tutorials/0_config.md (100%) rename {docs_zh-CN => docs/zh_cn}/tutorials/1_finetune.md (100%) rename {docs_zh-CN => docs/zh_cn}/tutorials/2_new_dataset.md (100%) rename {docs_zh-CN => docs/zh_cn}/tutorials/3_data_pipeline.md (100%) rename {docs_zh-CN => docs/zh_cn}/tutorials/4_new_modules.md (100%) rename {docs_zh-CN => docs/zh_cn}/tutorials/5_export_model.md (100%) rename {docs_zh-CN => docs/zh_cn}/tutorials/6_customize_runtime.md (100%) rename {docs_zh-CN => docs/zh_cn}/useful_tools.md (100%) delete mode 100644 docs_zh-CN/conf.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6bfa694aa4e..e0c679b14e6 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -11,7 +11,6 @@ on: - 'README.md' - 'README_CN.md' - 'docs/**' - - 'docs_zh-CN/**' - 'examples/**' - '.dev_scripts/**' @@ -20,7 +19,6 @@ on: - 'README.md' - 'README_CN.md' - 'docs/**' - - 'docs_zh-CN/**' - 'examples/**' - '.dev_scripts/**' diff --git a/.gitignore b/.gitignore index cf8302bcb7f..1b18d31b7f8 100644 --- a/.gitignore +++ b/.gitignore @@ -65,8 +65,8 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ -docs_zh-CN/_build/ +docs/en/_build +docs/zh_cn/_build # PyBuilder target/ @@ -116,14 +116,10 @@ mmpose/.mim *.log.json *.npy work_dirs/ -docs/topics/ -docs/papers/*.md -docs/datasets.md -docs/modelzoo.md -docs_zh-CN/topics/ -docs_zh-CN/papers/*.md -docs_zh-CN/datasets.md -docs_zh-CN/modelzoo.md +docs/**/topics/ +docs/**/papers/*.md +docs/**/datasets.md +docs/**/modelzoo.md !tests/data/**/*.pkl !tests/data/**/*.pkl.json diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d667bd9afb1..f20a69587f6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -59,5 +59,5 @@ repos: description: Add OpenMMLab copyright header to files entry: .dev_scripts/github/update_copyright.py language: python - files: ^(demo|docs|docs_zh-CN|mmpose|tests|tools|\.dev_scripts)/.*\.(py|c|cpp|cu|sh)$ + files: ^(demo|docs|mmpose|tests|tools|\.dev_scripts)/.*\.(py|c|cpp|cu|sh)$ exclude: ^demo/mm(detection|tracking)_cfg/.*$ diff --git a/README.md b/README.md index 706f671c279..7c0daef8b82 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,12 @@ https://user-images.githubusercontent.com/15977946/124654387-0fd3c500-ded1-11eb- - **Higher efficiency and higher accuracy** MMPose implements multiple state-of-the-art (SOTA) deep learning models, including both top-down & bottom-up approaches. We achieve faster training speed and higher accuracy than other popular codebases, such as [HRNet](https://github.com/leoxiaobin/deep-high-resolution-net.pytorch). - See [benchmark.md](docs/benchmark.md) for more information. + See [benchmark.md](docs/en/benchmark.md) for more information. - **Support for various datasets** The toolbox directly supports multiple popular and representative datasets, COCO, AIC, MPII, MPII-TRB, OCHuman etc. - See [data_preparation.md](docs/data_preparation.md) for more information. + See [data_preparation.md](docs/en/data_preparation.md) for more information. - **Well designed, tested and documented** @@ -163,38 +163,38 @@ We demonstrate the superiority of our MMPose framework in terms of speed and acc | hrnet_w48 | 256x192 | **0.66** | 1.55 | **0.756** | 0.751 | | hrnet_w48 | 384x288 | **1.23** | 2.20 | **0.767** | 0.763 | -More details about the benchmark are available on [benchmark.md](docs/benchmark.md). +More details about the benchmark are available on [benchmark.md](docs/en/benchmark.md). ## Inference Speed We summarize the model complexity and inference speed of major models in MMPose, including FLOPs, parameter counts and inference speeds on both CPU and GPU devices with different batch sizes. -Please refer to [inference_speed_summary.md](docs/inference_speed_summary.md) for more details. +Please refer to [inference_speed_summary.md](docs/en/inference_speed_summary.md) for more details. ## Installation -Please refer to [install.md](docs/install.md) for installation. +Please refer to [install.md](docs/en/install.md) for installation. ## Data Preparation -Please refer to [data_preparation.md](docs/data_preparation.md) for a general knowledge of data preparation. +Please refer to [data_preparation.md](docs/en/data_preparation.md) for a general knowledge of data preparation. ## Get Started -Please see [getting_started.md](docs/getting_started.md) for the basic usage of MMPose. +Please see [getting_started.md](docs/en/getting_started.md) for the basic usage of MMPose. There are also tutorials: -- [learn about configs](docs/tutorials/0_config.md) -- [finetune model](docs/tutorials/1_finetune.md) -- [add new dataset](docs/tutorials/2_new_dataset.md) -- [customize data pipelines](docs/tutorials/3_data_pipeline.md) -- [add new modules](docs/tutorials/4_new_modules.md) -- [export a model to ONNX](docs/tutorials/5_export_model.md) -- [customize runtime settings](docs/tutorials/6_customize_runtime.md) +- [learn about configs](docs/en/tutorials/0_config.md) +- [finetune model](docs/en/tutorials/1_finetune.md) +- [add new dataset](docs/en/tutorials/2_new_dataset.md) +- [customize data pipelines](docs/en/tutorials/3_data_pipeline.md) +- [add new modules](docs/en/tutorials/4_new_modules.md) +- [export a model to ONNX](docs/en/tutorials/5_export_model.md) +- [customize runtime settings](docs/en/tutorials/6_customize_runtime.md) ## FAQ -Please refer to [FAQ](docs/faq.md) for frequently asked questions. +Please refer to [FAQ](docs/en/faq.md) for frequently asked questions. ## License diff --git a/README_CN.md b/README_CN.md index f8835d1b4a7..df7ea28e260 100644 --- a/README_CN.md +++ b/README_CN.md @@ -30,11 +30,11 @@ https://user-images.githubusercontent.com/15977946/124654387-0fd3c500-ded1-11eb- - **更高的精度和更快的速度** MMPose 复现了多种学界最先进的人体姿态分析模型，包括“自顶向下”和“自底向上”两大类算法。MMPose 相比于其他主流的代码库，具有更高的模型精度和训练速度。 - 具体请参考 [基准测试](docs/benchmark.md)。 + 具体请参考 [基准测试](docs/en/benchmark.md)（英文）。 - **支持多样的数据集** - MMPose 支持了很多主流数据集的准备和构建，如 COCO、 MPII 等。 具体请参考 [数据集准备](docs/data_preparation.md)。 + MMPose 支持了很多主流数据集的准备和构建，如 COCO、 MPII 等。 具体请参考 [数据集准备](docs/en/data_preparation.md)。 - **模块化设计** @@ -162,38 +162,38 @@ https://user-images.githubusercontent.com/15977946/124654387-0fd3c500-ded1-11eb- | hrnet_w48 | 256x192 | **0.66** | 1.55 | **0.756** | 0.751 | | hrnet_w48 | 384x288 | **1.23** | 2.20 | **0.767** | 0.763 | -更多详情可见 [基准测试](docs/benchmark.md)。 +更多详情可见 [基准测试](docs/en/benchmark.md)(英文)。 ## 推理速度 我们总结了 MMPose 中主要模型的复杂度信息和推理速度，包括模型的计算复杂度、参数数量，以及以不同的批处理大小在 CPU 和 GPU 上的推理速度。 -详细信息可见 [模型推理速度](docs_zh-CN/inference_speed_summary.md). +详细信息可见 [模型推理速度](docs/zh_cn/inference_speed_summary.md). ## 安装 -请参考 [安装指南](docs/install.md) 进行安装。 +请参考 [安装指南](docs/zh_cn/install.md) 进行安装。 ## 数据准备 -请参考 [data_preparation.md](docs/data_preparation.md) 进行数据集准备。 +请参考 [data_preparation.md](docs/en/data_preparation.md)（英文） 进行数据集准备。 ## 教程 -请参考 [getting_started.md](docs/getting_started.md) 了解 MMPose 的基本使用。 +请参考 [getting_started.md](docs/zh_cn/getting_started.md) 了解 MMPose 的基本使用。 MMPose 也提供了其他更详细的教程: -- [如何编写配置文件](docs/tutorials/0_config.md) -- [如何微调模型](docs/tutorials/1_finetune.md) -- [如何增加新数据集](docs/tutorials/2_new_dataset.md) -- [如何设计数据处理流程](docs/tutorials/3_data_pipeline.md) -- [如何增加新模块](docs/tutorials/4_new_modules.md) -- [如何导出模型为 onnx 格式](docs/tutorials/5_export_model.md) -- [如何自定义模型运行参数](docs/tutorials/6_customize_runtime.md) +- [如何编写配置文件](docs/zh_cn/tutorials/0_config.md) +- [如何微调模型](docs/zh_cn/tutorials/1_finetune.md) +- [如何增加新数据集](docs/zh_cn/tutorials/2_new_dataset.md) +- [如何设计数据处理流程](docs/zh_cn/tutorials/3_data_pipeline.md) +- [如何增加新模块](docs/zh_cn/tutorials/4_new_modules.md) +- [如何导出模型为 onnx 格式](docs/zh_cn/tutorials/5_export_model.md) +- [如何自定义模型运行参数](docs/en/tutorials/6_customize_runtime.md)(英文) ## 常见问题 -请参考 [FAQ](docs/faq.md) 了解其他用户的常见问题。 +请参考 [FAQ](docs/en/faq.md) 了解其他用户的常见问题。 ## 许可 @@ -244,7 +244,7 @@ MMPose 是一款由不同学校和公司共同贡献的开源项目。我们感 扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab)，加入 OpenMMLab 团队的 [官方交流 QQ 群](https://jq.qq.com/?_wv=1027&k=GJP18SjI)
- +
我们会在 OpenMMLab 社区为大家 diff --git a/configs/animal/2d_kpt_sview_rgb_img/README.md b/configs/animal/2d_kpt_sview_rgb_img/README.md index 4df19feab9b..8fa18673f8b 100644 --- a/configs/animal/2d_kpt_sview_rgb_img/README.md +++ b/configs/animal/2d_kpt_sview_rgb_img/README.md @@ -5,11 +5,11 @@ dogs, macaques, and cheetah. It provides detailed behavioral analysis for neuros ## Data preparation -Please follow [DATA Preparation](/docs/tasks/2d_animal_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/2d_animal_keypoint.md) to prepare data. ## Demo -Please follow [DEMO](/demo/docs/2d_animal_demo.md) to generate fancy demos. +Please follow [DEMO](/demo/docs/en/2d_animal_demo.md) to generate fancy demos.
diff --git a/configs/body/2d_kpt_sview_rgb_img/README.md b/configs/body/2d_kpt_sview_rgb_img/README.md index dbd55526b57..01f3e3c9b3a 100644 --- a/configs/body/2d_kpt_sview_rgb_img/README.md +++ b/configs/body/2d_kpt_sview_rgb_img/README.md @@ -10,10 +10,10 @@ Bottom-up approaches (e.g. AE) first detect all the keypoints and then group/ass ## Data preparation -Please follow [DATA Preparation](/docs/tasks/2d_body_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/2d_body_keypoint.md) to prepare data. ## Demo -Please follow [Demo](/demo/docs/2d_human_pose_demo.md#2d-human-pose-demo) to run demos. +Please follow [Demo](/demo/docs/en/2d_human_pose_demo.md#2d-human-pose-demo) to run demos. diff --git a/configs/body/2d_kpt_sview_rgb_vid/README.md b/configs/body/2d_kpt_sview_rgb_vid/README.md index 614c6d9f896..c638432b501 100644 --- a/configs/body/2d_kpt_sview_rgb_vid/README.md +++ b/configs/body/2d_kpt_sview_rgb_vid/README.md @@ -6,4 +6,4 @@ For this task, we currently support [PoseWarper](/configs/body/2d_kpt_sview_rgb_ ## Data preparation -Please follow [DATA Preparation](/docs/tasks/2d_body_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/2d_body_keypoint.md) to prepare data. diff --git a/configs/body/2d_kpt_sview_rgb_vid/posewarper/posetrack18/hrnet_posetrack18_posewarper.md b/configs/body/2d_kpt_sview_rgb_vid/posewarper/posetrack18/hrnet_posetrack18_posewarper.md index 25e852dcc9c..0fd0a7f5af0 100644 --- a/configs/body/2d_kpt_sview_rgb_vid/posewarper/posetrack18/hrnet_posetrack18_posewarper.md +++ b/configs/body/2d_kpt_sview_rgb_vid/posewarper/posetrack18/hrnet_posetrack18_posewarper.md @@ -85,4 +85,4 @@ Results on PoseTrack2018 val with precomputed human bounding boxes from PoseWarp | :--- | :--------: | :------: |:------: |:------: |:------: |:------: |:------: | :------: | :------: |:------: |:------: | | [pose_hrnet_w48](/configs/body/2d_kpt_sview_rgb_vid/posewarper/posetrack18/hrnet_w48_posetrack18_384x288_posewarper_stage2.py) | 384x288 | 81.8 | 85.6 | 82.7 | 77.2 | 76.8 | 79.0 | 74.4 | 79.8 | [ckpt](https://download.openmmlab.com/mmpose/top_down/posewarper/hrnet_w48_posetrack18_384x288_posewarper_stage2-4abf88db_20211130.pth) | [log](https://download.openmmlab.com/mmpose/top_down/posewarper/hrnet_w48_posetrack18_384x288_posewarper_stage2_20211130.log.json) | -1 Please download the precomputed human bounding boxes on PoseTrack2018 val from `$PoseWarper_supp_files/posetrack18_precomputed_boxes/val_boxes.json` and place it here: `$mmpose/data/posetrack18/posetrack18_precomputed_boxes/val_boxes.json` to be consistent with the [config](/configs/body/2d_kpt_sview_rgb_vid/posewarper/posetrack18/hrnet_w48_posetrack18_384x288_posewarper_stage2.py). Please refer to [DATA Preparation](/docs/tasks/2d_body_keypoint.md) for more detail about data preparation. +1 Please download the precomputed human bounding boxes on PoseTrack2018 val from `$PoseWarper_supp_files/posetrack18_precomputed_boxes/val_boxes.json` and place it here: `$mmpose/data/posetrack18/posetrack18_precomputed_boxes/val_boxes.json` to be consistent with the [config](/configs/body/2d_kpt_sview_rgb_vid/posewarper/posetrack18/hrnet_w48_posetrack18_384x288_posewarper_stage2.py). Please refer to [DATA Preparation](/docs/en/tasks/2d_body_keypoint.md) for more detail about data preparation. diff --git a/configs/body/3d_kpt_sview_rgb_img/README.md b/configs/body/3d_kpt_sview_rgb_img/README.md index 6c85a580028..7f69d2d07bc 100644 --- a/configs/body/3d_kpt_sview_rgb_img/README.md +++ b/configs/body/3d_kpt_sview_rgb_img/README.md @@ -8,10 +8,10 @@ For single-person 3D pose estimation from a monocular camera, existing works can ## Data preparation -Please follow [DATA Preparation](/docs/tasks/3d_body_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/3d_body_keypoint.md) to prepare data. ## Demo -Please follow [Demo](/demo/docs/3d_human_pose_demo.md) to run demos. +Please follow [Demo](/demo/docs/en/3d_human_pose_demo.md) to run demos.
diff --git a/configs/body/3d_kpt_sview_rgb_vid/README.md b/configs/body/3d_kpt_sview_rgb_vid/README.md index 43315429d73..8473efc0745 100644 --- a/configs/body/3d_kpt_sview_rgb_vid/README.md +++ b/configs/body/3d_kpt_sview_rgb_vid/README.md @@ -8,4 +8,4 @@ For single-person 3D pose estimation from a monocular camera, existing works can ## Data preparation -Please follow [DATA Preparation](/docs/tasks/3d_body_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/3d_body_keypoint.md) to prepare data. diff --git a/configs/body/3d_mesh_sview_rgb_img/README.md b/configs/body/3d_mesh_sview_rgb_img/README.md index a4a80f711a5..a0c7817f40f 100644 --- a/configs/body/3d_mesh_sview_rgb_img/README.md +++ b/configs/body/3d_mesh_sview_rgb_img/README.md @@ -11,7 +11,7 @@ The preparation for human mesh recovery mainly includes: - Annotations - SMPL Model -Please follow [DATA Preparation](/docs/tasks/3d_body_mesh.md) to prepare them. +Please follow [DATA Preparation](/docs/en/tasks/3d_body_mesh.md) to prepare them. ## Prepare Pretrained Models diff --git a/configs/face/2d_kpt_sview_rgb_img/README.md b/configs/face/2d_kpt_sview_rgb_img/README.md index ff9e520fe86..f2b07b4b4a8 100644 --- a/configs/face/2d_kpt_sview_rgb_img/README.md +++ b/configs/face/2d_kpt_sview_rgb_img/README.md @@ -7,10 +7,10 @@ or the rough location (or the bounding box) of the hand is provided. ## Data preparation -Please follow [DATA Preparation](/docs/tasks/2d_face_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/2d_face_keypoint.md) to prepare data. ## Demo -Please follow [Demo](/demo/docs/2d_face_demo.md) to run demos. +Please follow [Demo](/demo/docs/en/2d_face_demo.md) to run demos.
diff --git a/configs/fashion/2d_kpt_sview_rgb_img/README.md b/configs/fashion/2d_kpt_sview_rgb_img/README.md index d20ff4f8f8e..6818d3dc1d7 100644 --- a/configs/fashion/2d_kpt_sview_rgb_img/README.md +++ b/configs/fashion/2d_kpt_sview_rgb_img/README.md @@ -4,4 +4,4 @@ ## Data preparation -Please follow [DATA Preparation](/docs/tasks/2d_fashion_landmark.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/2d_fashion_landmark.md) to prepare data. diff --git a/configs/hand/2d_kpt_sview_rgb_img/README.md b/configs/hand/2d_kpt_sview_rgb_img/README.md index 27583153d53..07bd96924fc 100644 --- a/configs/hand/2d_kpt_sview_rgb_img/README.md +++ b/configs/hand/2d_kpt_sview_rgb_img/README.md @@ -7,10 +7,10 @@ or the rough location (or the bounding box) of the hand is provided. ## Data preparation -Please follow [DATA Preparation](/docs/tasks/2d_hand_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/2d_hand_keypoint.md) to prepare data. ## Demo -Please follow [Demo](/demo/docs/2d_hand_demo.md) to run demos. +Please follow [Demo](/demo/docs/en/2d_hand_demo.md) to run demos.
diff --git a/configs/hand/3d_kpt_sview_rgb_img/README.md b/configs/hand/3d_kpt_sview_rgb_img/README.md index fc9ab64ec5a..c058280df2d 100644 --- a/configs/hand/3d_kpt_sview_rgb_img/README.md +++ b/configs/hand/3d_kpt_sview_rgb_img/README.md @@ -4,4 +4,4 @@ ## Data preparation -Please follow [DATA Preparation](/docs/tasks/3d_hand_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/3d_hand_keypoint.md) to prepare data. diff --git a/configs/wholebody/2d_kpt_sview_rgb_img/README.md b/configs/wholebody/2d_kpt_sview_rgb_img/README.md index 942765aeecd..d3b9d3ee675 100644 --- a/configs/wholebody/2d_kpt_sview_rgb_img/README.md +++ b/configs/wholebody/2d_kpt_sview_rgb_img/README.md @@ -10,10 +10,10 @@ Bottom-up approaches (e.g. AE) first detect all the whole-body keypoints and the ## Data preparation -Please follow [DATA Preparation](/docs/tasks/2d_wholebody_keypoint.md) to prepare data. +Please follow [DATA Preparation](/docs/en/tasks/2d_wholebody_keypoint.md) to prepare data. ## Demo -Please follow [Demo](/demo/docs/2d_wholebody_pose_demo.md) to run demos. +Please follow [Demo](/demo/docs/en/2d_wholebody_pose_demo.md) to run demos.
diff --git a/demo/docs/2d_pose_tracking_demo.md b/demo/docs/2d_pose_tracking_demo.md index 575886cd2c1..9b299413b2d 100644 --- a/demo/docs/2d_pose_tracking_demo.md +++ b/demo/docs/2d_pose_tracking_demo.md @@ -91,7 +91,7 @@ For top-down models, try to edit the config file. For example, 1. set `flip_test=False` in [topdown-res50](https://github.com/open-mmlab/mmpose/tree/e1ec589884235bee875c89102170439a991f8450/configs/top_down/resnet/coco/res50_coco_256x192.py#L51). 1. set `post_process='default'` in [topdown-res50](https://github.com/open-mmlab/mmpose/tree/e1ec589884235bee875c89102170439a991f8450/configs/top_down/resnet/coco/res50_coco_256x192.py#L52). -1. use faster human detector or human tracker, see [MMDetection](https://mmdetection.readthedocs.io/en/latest/model_zoo.html) or [MMTracking](https://github.com/open-mmlab/mmtracking/blob/master/docs/model_zoo.md). +1. use faster human detector or human tracker, see [MMDetection](https://mmdetection.readthedocs.io/en/latest/model_zoo.html) or [MMTracking](https://mmtracking.readthedocs.io/en/latest/model_zoo.html). For bottom-up models, try to edit the config file. For example, diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 5c6bed76016..00000000000 --- a/docs/conf.py +++ /dev/null @@ -1,214 +0,0 @@ -# Copyright (c) OpenMMLab. All rights reserved. -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import subprocess -import sys - -import pytorch_sphinx_theme - -sys.path.insert(0, os.path.abspath('..')) - -# -- Project information ----------------------------------------------------- - -project = 'MMPose' -copyright = '2020-2021, OpenMMLab' -author = 'MMPose Authors' - -# The full version, including alpha/beta/rc tags -version_file = '../mmpose/version.py' - - -def get_version(): - with open(version_file, 'r') as f: - exec(compile(f.read(), version_file, 'exec')) - return locals()['__version__'] - - -release = get_version() - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', - 'sphinx_markdown_tables', 'sphinx_copybutton', 'myst_parser' -] - -autodoc_mock_imports = ['json_tricks', 'mmpose.version'] - -# Ignore >>> when copying code -copybutton_prompt_text = r'>>> |\.\.\. ' -copybutton_prompt_is_regexp = True - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# -- Options for HTML output ------------------------------------------------- -source_suffix = { - '.rst': 'restructuredtext', - '.md': 'markdown', -} - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'pytorch_sphinx_theme' -html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()] -html_theme_options = { - 'menu': [ - { - 'name': - 'Tutorial', - 'url': - 'https://colab.research.google.com/github/' - 'open-mmlab/mmpose/blob/master/demo/MMPose_Tutorial.ipynb' - }, - { - 'name': 'GitHub', - 'url': 'https://github.com/open-mmlab/mmpose' - }, - { - 'name': - 'Projects', - 'children': [{ - 'name': - 'MMCV', - 'url': - 'https://mmcv.readthedocs.io/en/latest/', - 'description': - 'Foundational library for computer vision' - }, { - 'name': - 'MMDetection', - 'url': - 'https://mmdetection.readthedocs.io/en/latest/', - 'description': - 'Object detection toolbox and benchmark' - }, { - 'name': - 'MMAction2', - 'url': - 'https://mmaction2.readthedocs.io/en/latest/', - 'description': - 'Action understanding toolbox and benchmark' - }, { - 'name': - 'MMClassification', - 'url': - 'https://mmclassification.readthedocs.io/en/latest/', - 'description': - 'Image classification toolbox and benchmark' - }, { - 'name': - 'MMSegmentation', - 'url': - 'https://mmsegmentation.readthedocs.io/en/latest/', - 'description': - 'Semantic segmentation toolbox and benchmark' - }, { - 'name': 'MMDetection3D', - 'url': 'https://mmdetection3d.readthedocs.io/en/latest/', - 'description': 'General 3D object detection platform' - }, { - 'name': 'MMEditing', - 'url': 'https://mmediting.readthedocs.io/en/latest/', - 'description': 'Image and video editing toolbox' - }, { - 'name': - 'MMOCR', - 'url': - 'https://mmocr.readthedocs.io/en/latest/', - 'description': - 'Text detection, recognition and understanding toolbox' - }, { - 'name': - 'MMTracking', - 'url': - 'https://mmtracking.readthedocs.io/en/latest/', - 'description': - 'Video perception toolbox and benchmark' - }, { - 'name': 'MMGeneration', - 'url': 'https://mmgeneration.readthedocs.io/en/latest/', - 'description': 'Generative model toolbox' - }, { - 'name': 'MMFlow', - 'url': 'https://mmflow.readthedocs.io/en/latest/', - 'description': 'Optical flow toolbox and benchmark' - }, { - 'name': - 'MMFewShot', - 'url': - 'https://mmfewshot.readthedocs.io/en/latest/', - 'description': - 'FewShot learning toolbox and benchmark' - }, { - 'name': - 'MMHuman3D', - 'url': - 'https://mmhuman3d.readthedocs.io/en/latest/', - 'description': - '3D human parametric model toolbox and benchmark.' - }] - }, - { - 'name': - 'OpenMMLab', - 'children': [{ - 'name': 'Homepage', - 'url': 'https://openmmlab.com/' - }, { - 'name': 'GitHub', - 'url': 'https://github.com/open-mmlab/' - }, { - 'name': 'Twitter', - 'url': 'https://twitter.com/OpenMMLab' - }, { - 'name': 'Zhihu', - 'url': 'https://zhihu.com/people/openmmlab' - }] - }, - ] -} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". - -language = 'en' - -html_static_path = ['_static'] -html_css_files = ['css/readthedocs.css'] - -# Enable ::: for my_st -myst_enable_extensions = ['colon_fence'] - -master_doc = 'index' - - -def builder_inited_handler(app): - subprocess.run(['./collect.py']) - subprocess.run(['./merge_docs.sh']) - subprocess.run(['./stats.py']) - - -def setup(app): - app.connect('builder-inited', builder_inited_handler) diff --git a/docs/Makefile b/docs/en/Makefile similarity index 100% rename from docs/Makefile rename to docs/en/Makefile diff --git a/docs/_static/css/readthedocs.css b/docs/en/_static/css/readthedocs.css similarity index 100% rename from docs/_static/css/readthedocs.css rename to docs/en/_static/css/readthedocs.css diff --git a/docs/_static/images/mmpose-logo.png b/docs/en/_static/images/mmpose-logo.png similarity index 100% rename from docs/_static/images/mmpose-logo.png rename to docs/en/_static/images/mmpose-logo.png diff --git a/docs/api.rst b/docs/en/api.rst similarity index 100% rename from docs/api.rst rename to docs/en/api.rst diff --git a/docs/benchmark.md b/docs/en/benchmark.md similarity index 100% rename from docs/benchmark.md rename to docs/en/benchmark.md diff --git a/docs/changelog.md b/docs/en/changelog.md similarity index 98% rename from docs/changelog.md rename to docs/en/changelog.md index 5580a563d95..1b2974d3be4 100644 --- a/docs/changelog.md +++ b/docs/en/changelog.md @@ -6,7 +6,7 @@ - Support ["Learning Temporal Pose Estimation from Sparsely-Labeled Videos"](https://arxiv.org/abs/1906.04016), NeurIPS'2019 ([\#932](https://github.com/open-mmlab/mmpose/pull/932), [\#1006](https://github.com/open-mmlab/mmpose/pull/1006), [\#1036](https://github.com/open-mmlab/mmpose/pull/1036), [\#1060](https://github.com/open-mmlab/mmpose/pull/1060)) @liqikai9 - Add ViPNAS-MobileNetV3 models ([\#1025](https://github.com/open-mmlab/mmpose/pull/1025)) @luminxu, @jin-s13 -- Add [inference speed benchmark](/docs/inference_speed_summary.md) ([\#1028](https://github.com/open-mmlab/mmpose/pull/1028), [\#1034](https://github.com/open-mmlab/mmpose/pull/1034), [\#1044](https://github.com/open-mmlab/mmpose/pull/1044)) @liqikai9 +- Add [inference speed benchmark](/docs/en/inference_speed_summary.md) ([\#1028](https://github.com/open-mmlab/mmpose/pull/1028), [\#1034](https://github.com/open-mmlab/mmpose/pull/1034), [\#1044](https://github.com/open-mmlab/mmpose/pull/1044)) @liqikai9 **New Features** @@ -17,7 +17,7 @@ **Improvements** -- Add [inference speed benchmark](/docs/inference_speed_summary.md) ([\#1028](https://github.com/open-mmlab/mmpose/pull/1028), [\#1034](https://github.com/open-mmlab/mmpose/pull/1034), [\#1044](https://github.com/open-mmlab/mmpose/pull/1044)) @liqikai9 +- Add [inference speed benchmark](/docs/en/inference_speed_summary.md) ([\#1028](https://github.com/open-mmlab/mmpose/pull/1028), [\#1034](https://github.com/open-mmlab/mmpose/pull/1034), [\#1044](https://github.com/open-mmlab/mmpose/pull/1044)) @liqikai9 - Update model metafile format ([\#1001](https://github.com/open-mmlab/mmpose/pull/1001)) @ly015 - Support minus output feature index in mobilenet_v3 ([\#1005](https://github.com/open-mmlab/mmpose/pull/1005)) @luminxu - Improve documentation quality ([\#1018](https://github.com/open-mmlab/mmpose/pull/1018), [\#1026](https://github.com/open-mmlab/mmpose/pull/1026), [\#1027](https://github.com/open-mmlab/mmpose/pull/1027), [\#1031](https://github.com/open-mmlab/mmpose/pull/1031), [\#1038](https://github.com/open-mmlab/mmpose/pull/1038), [\#1046](https://github.com/open-mmlab/mmpose/pull/1046), [\#1056](https://github.com/open-mmlab/mmpose/pull/1056), [\#1057](https://github.com/open-mmlab/mmpose/pull/1057)) @edybk, @luminxu, @ly015, @jin-s13 diff --git a/docs/collect.py b/docs/en/collect.py similarity index 90% rename from docs/collect.py rename to docs/en/collect.py index 96e1ccdbe57..5f8aedee061 100755 --- a/docs/collect.py +++ b/docs/en/collect.py @@ -11,7 +11,7 @@ # Step 1: get subtopics: a mix of topic and task minisections = [ - x.split('/')[-2:] for x in glob('../configs/*/*') if '_base_' not in x + x.split('/')[-2:] for x in glob('../../configs/*/*') if '_base_' not in x ] alltopics = sorted(list(set(x[0] for x in minisections))) subtopics = [] @@ -36,11 +36,11 @@ list( set( x.split('/')[-2] - for x in glob(f'../configs/{topic}/{task}/*/*/')))) + for x in glob(f'../../configs/{topic}/{task}/*/*/')))) contents[subtopic] = {d: {} for d in datasets} for dataset in datasets: # Step 3: get all settings: algorithm + backbone + trick - for file in glob(f'../configs/{topic}/{task}/*/{dataset}/*.md'): + for file in glob(f'../../configs/{topic}/{task}/*/{dataset}/*.md'): keywords = (file.split('/')[-3], *file.split('/')[-1].split('_')[:-1]) with open(file, 'r') as f: @@ -67,13 +67,13 @@ f.write('\n'.join(lines)) # Step 5: write files by paper -allfiles = [x.split('/')[-2:] for x in glob('../docs/papers/*/*.md')] +allfiles = [x.split('/')[-2:] for x in glob('../en/papers/*/*.md')] sections = sorted(list(set(x[0] for x in allfiles))) for section in sections: lines = [f'# {titlecase(section)}', ''] files = [f for s, f in allfiles if s == section] for file in files: - with open(f'../docs/papers/{section}/{file}', 'r') as f: + with open(f'../en/papers/{section}/{file}', 'r') as f: keyline = [ line for line in f.readlines() if line.startswith('>> when copying code +copybutton_prompt_text = r'>>> |\.\.\. ' +copybutton_prompt_is_regexp = True + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# -- Options for HTML output ------------------------------------------------- +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'pytorch_sphinx_theme' +html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()] +html_theme_options = { + 'menu': [ + { + 'name': + 'Tutorial', + 'url': + 'https://colab.research.google.com/github/' + 'open-mmlab/mmpose/blob/master/demo/MMPose_Tutorial.ipynb' + }, + { + 'name': 'GitHub', + 'url': 'https://github.com/open-mmlab/mmpose' + }, + ], + # Specify the language of the shared menu + 'menu_lang': + 'en' +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". + +language = 'en' + +html_static_path = ['_static'] +html_css_files = ['css/readthedocs.css'] + +# Enable ::: for my_st +myst_enable_extensions = ['colon_fence'] + +master_doc = 'index' + + +def builder_inited_handler(app): + subprocess.run(['./collect.py']) + subprocess.run(['./merge_docs.sh']) + subprocess.run(['./stats.py']) + + +def setup(app): + app.connect('builder-inited', builder_inited_handler) diff --git a/docs/data_preparation.md b/docs/en/data_preparation.md similarity index 100% rename from docs/data_preparation.md rename to docs/en/data_preparation.md diff --git a/docs/faq.md b/docs/en/faq.md similarity index 80% rename from docs/faq.md rename to docs/en/faq.md index 035e681a39c..1ea6575ce33 100644 --- a/docs/faq.md +++ b/docs/en/faq.md @@ -35,17 +35,6 @@ If the contents here do not cover your issue, please create an issue using the [ ## Data -- **How to convert my 2d keypoint dataset to coco-type?** - - You may refer to this conversion [tool](https://github.com/open-mmlab/mmpose/blob/master/tools/dataset/parse_macaquepose_dataset.py) to prepare your data. - Here is an [example](https://github.com/open-mmlab/mmpose/blob/master/tests/data/macaque/test_macaque.json) of the coco-type json. - In the coco-type json, we need "categories", "annotations" and "images". "categories" contain some basic information of the dataset, e.g. class name and keypoint names. - "images" contain image-level information. We need "id", "file_name", "height", "width". Others are optional. - Note: (1) It is okay that "id"s are not continuous or not sorted (e.g. 1000, 40, 352, 333 ...). - - "annotations" contain instance-level information. We need "image_id", "id", "keypoints", "num_keypoints", "bbox", "iscrowd", "area", "category_id". Others are optional. - Note: (1) "num_keypoints" means the number of visible keypoints. (2) By default, please set "iscrowd: 0". (3) "area" can be calculated using the bbox (area = w * h) (4) Simply set "category_id: 1". (5) The "image_id" in "annotations" should match the "id" in "images". - - **What if my custom dataset does not have bounding box label?** We can estimate the bounding box of a person as the minimal box that tightly bounds all the keypoints. @@ -73,7 +62,7 @@ If the contents here do not cover your issue, please create an issue using the [ - **How to use trained models for backbone pre-training ?** - Refer to [Use Pre-Trained Model](https://github.com/open-mmlab/mmpose/blob/master/docs/tutorials/1_finetune.md#use-pre-trained-model), + Refer to [Use Pre-Trained Model](/docs/en/tutorials/1_finetune.md#use-pre-trained-model), in order to use the pre-trained model for the whole network (backbone + head), the new config adds the link of pre-trained models in the `load_from`. And to use backbone for pre-training, you can change `pretrained` value in the backbone dict of config files to the checkpoint path / url. @@ -104,9 +93,6 @@ If the contents here do not cover your issue, please create an issue using the [ Since we do not have the ground-truth for test dataset, we cannot evaluate it 'locally'. If you would like to evaluate the performance on test set, you have to upload the pred.mat (which is generated during testing) to the official server via email, according to [the MPII guideline](http://human-pose.mpi-inf.mpg.de/#evaluation). -- **For top-down 2d pose estimation, why predicted joint coordinates can be out of the bounding box (bbox)?** - We do not directly use the bbox to crop the image. bbox will be first transformed to center & scale, and the scale will be multiplied by a factor (1.25) to include some context. If the ratio of width/height is different from that of model input (possibly 192/256), we will adjust the bbox. - ## Inference - **How to run mmpose on CPU?** diff --git a/docs/getting_started.md b/docs/en/getting_started.md similarity index 94% rename from docs/getting_started.md rename to docs/en/getting_started.md index c095f7cba37..ff9a6090f28 100644 --- a/docs/getting_started.md +++ b/docs/en/getting_started.md @@ -23,15 +23,15 @@ For installation instructions, please see [install.md](install.md). MMPose supports multiple tasks. Please follow the corresponding guidelines for data preparation. -- [2D Body Keypoint Detection](/docs/tasks/2d_body_keypoint.md) -- [3D Body Keypoint Detection](/docs/tasks/3d_body_keypoint.md) -- [3D Body Mesh Recovery](/docs/tasks/3d_body_mesh.md) -- [2D Hand Keypoint Detection](/docs/tasks/2d_hand_keypoint.md) -- [3D Hand Keypoint Detection](/docs/tasks/3d_hand_keypoint.md) -- [2D Face Keypoint Detection](/docs/tasks/2d_face_keypoint.md) -- [2D WholeBody Keypoint Detection](/docs/tasks/2d_wholebody_keypoint.md) -- [2D Fashion Landmark Detection](/docs/tasks/2d_fashion_landmark.md) -- [2D Animal Keypoint Detection](/docs/tasks/2d_animal_keypoint.md) +- [2D Body Keypoint Detection](/docs/en/tasks/2d_body_keypoint.md) +- [3D Body Keypoint Detection](/docs/en/tasks/3d_body_keypoint.md) +- [3D Body Mesh Recovery](/docs/en/tasks/3d_body_mesh.md) +- [2D Hand Keypoint Detection](/docs/en/tasks/2d_hand_keypoint.md) +- [3D Hand Keypoint Detection](/docs/en/tasks/3d_hand_keypoint.md) +- [2D Face Keypoint Detection](/docs/en/tasks/2d_face_keypoint.md) +- [2D WholeBody Keypoint Detection](/docs/en/tasks/2d_wholebody_keypoint.md) +- [2D Fashion Landmark Detection](/docs/en/tasks/2d_fashion_landmark.md) +- [2D Animal Keypoint Detection](/docs/en/tasks/2d_animal_keypoint.md) ## Inference with Pre-trained Models @@ -205,7 +205,7 @@ GPUS=16 GPUS_PER_NODE=8 CPUS_PER_TASK=2 ./tools/slurm_train.sh Test res50 config You can check [slurm_train.sh](/tools/slurm_train.sh) for full arguments and environment variables. If you have just multiple machines connected with ethernet, you can refer to -pytorch [launch utility](https://pytorch.org/docs/stable/distributed_deprecated.html#launch-utility). +pytorch [launch utility](https://pytorch.org/docs/en/stable/distributed_deprecated.html#launch-utility). Usually it is slow if you do not have high speed networking like InfiniBand. ### Launch multiple jobs on a single machine diff --git a/docs/imgs/acc_curve.png b/docs/en/imgs/acc_curve.png similarity index 100% rename from docs/imgs/acc_curve.png rename to docs/en/imgs/acc_curve.png diff --git a/docs/imgs/qq_group2_qrcode.jpg b/docs/en/imgs/qq_group2_qrcode.jpg similarity index 100% rename from docs/imgs/qq_group2_qrcode.jpg rename to docs/en/imgs/qq_group2_qrcode.jpg diff --git a/docs/imgs/qq_group_qrcode.jpg b/docs/en/imgs/qq_group_qrcode.jpg similarity index 100% rename from docs/imgs/qq_group_qrcode.jpg rename to docs/en/imgs/qq_group_qrcode.jpg diff --git a/docs/imgs/zhihu_qrcode.jpg b/docs/en/imgs/zhihu_qrcode.jpg similarity index 100% rename from docs/imgs/zhihu_qrcode.jpg rename to docs/en/imgs/zhihu_qrcode.jpg diff --git a/docs/index.rst b/docs/en/index.rst similarity index 98% rename from docs/index.rst rename to docs/en/index.rst index 7da83cdc3eb..ac6873eb95f 100644 --- a/docs/index.rst +++ b/docs/en/index.rst @@ -36,6 +36,7 @@ You can change the documentation language at the lower-left corner of the page. modelzoo.md topics/animal.md topics/body(2d,kpt,img).md + topics/body(2d,kpt,vid).md topics/body(3d,kpt,img).md topics/body(3d,kpt,vid).md topics/body(3d,mesh,img).md diff --git a/docs/inference_speed_summary.md b/docs/en/inference_speed_summary.md similarity index 100% rename from docs/inference_speed_summary.md rename to docs/en/inference_speed_summary.md diff --git a/docs/install.md b/docs/en/install.md similarity index 100% rename from docs/install.md rename to docs/en/install.md diff --git a/docs/language.md b/docs/en/language.md similarity index 100% rename from docs/language.md rename to docs/en/language.md diff --git a/docs/make.bat b/docs/en/make.bat similarity index 100% rename from docs/make.bat rename to docs/en/make.bat diff --git a/docs/merge_docs.sh b/docs/en/merge_docs.sh similarity index 58% rename from docs/merge_docs.sh rename to docs/en/merge_docs.sh index df4eaf68cb0..6484b78f435 100755 --- a/docs/merge_docs.sh +++ b/docs/en/merge_docs.sh @@ -1,20 +1,20 @@ #!/usr/bin/env bash # Copyright (c) OpenMMLab. All rights reserved. -sed -i '$a\\n' ../demo/docs/*_demo.md -cat ../demo/docs/*_demo.md | sed "s/#/#&/" | sed "s/md###t/html#t/g" | sed '1i\# Demo' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmpose/tree/master/=g' >demo.md +sed -i '$a\\n' ../../demo/docs/*_demo.md +cat ../../demo/docs/*_demo.md | sed "s/#/#&/" | sed "s/md###t/html#t/g" | sed '1i\# Demo' | sed 's=](/docs/en/=](/=g' | sed 's=](/=](https://github.com/open-mmlab/mmpose/tree/master/=g' >demo.md # remove /docs/ for link used in doc site -sed -i 's/](\/docs\//](/g' ./tutorials/*.md -sed -i 's/](\/docs\//](/g' ./tasks/*.md -sed -i 's/](\/docs\//](/g' ./papers/*.md -sed -i 's/](\/docs\//](/g' ./topics/*.md -sed -i 's/](\/docs\//](/g' data_preparation.md -sed -i 's/](\/docs\//](/g' getting_started.md -sed -i 's/](\/docs\//](/g' install.md -sed -i 's/](\/docs\//](/g' benchmark.md -sed -i 's/](\/docs\//](/g' changelog.md -sed -i 's/](\/docs\//](/g' faq.md +sed -i 's=](/docs/en/=](=g' ./tutorials/*.md +sed -i 's=](/docs/en/=](=g' ./tasks/*.md +sed -i 's=](/docs/en/=](=g' ./papers/*.md +sed -i 's=](/docs/en/=](=g' ./topics/*.md +sed -i 's=](/docs/en/=](=g' data_preparation.md +sed -i 's=](/docs/en/=](=g' getting_started.md +sed -i 's=](/docs/en/=](=g' install.md +sed -i 's=](/docs/en/=](=g' benchmark.md +sed -i 's=](/docs/en/=](=g' changelog.md +sed -i 's=](/docs/en/=](=g' faq.md sed -i 's=](/=](https://github.com/open-mmlab/mmpose/tree/master/=g' ./tutorials/*.md sed -i 's=](/=](https://github.com/open-mmlab/mmpose/tree/master/=g' ./tasks/*.md diff --git a/docs/papers/algorithms/associative_embedding.md b/docs/en/papers/algorithms/associative_embedding.md similarity index 100% rename from docs/papers/algorithms/associative_embedding.md rename to docs/en/papers/algorithms/associative_embedding.md diff --git a/docs/papers/algorithms/cpm.md b/docs/en/papers/algorithms/cpm.md similarity index 100% rename from docs/papers/algorithms/cpm.md rename to docs/en/papers/algorithms/cpm.md diff --git a/docs/papers/algorithms/dark.md b/docs/en/papers/algorithms/dark.md similarity index 100% rename from docs/papers/algorithms/dark.md rename to docs/en/papers/algorithms/dark.md diff --git a/docs/papers/algorithms/deeppose.md b/docs/en/papers/algorithms/deeppose.md similarity index 100% rename from docs/papers/algorithms/deeppose.md rename to docs/en/papers/algorithms/deeppose.md diff --git a/docs/papers/algorithms/higherhrnet.md b/docs/en/papers/algorithms/higherhrnet.md similarity index 100% rename from docs/papers/algorithms/higherhrnet.md rename to docs/en/papers/algorithms/higherhrnet.md diff --git a/docs/papers/algorithms/hmr.md b/docs/en/papers/algorithms/hmr.md similarity index 100% rename from docs/papers/algorithms/hmr.md rename to docs/en/papers/algorithms/hmr.md diff --git a/docs/papers/algorithms/hourglass.md b/docs/en/papers/algorithms/hourglass.md similarity index 100% rename from docs/papers/algorithms/hourglass.md rename to docs/en/papers/algorithms/hourglass.md diff --git a/docs/papers/algorithms/hrnet.md b/docs/en/papers/algorithms/hrnet.md similarity index 100% rename from docs/papers/algorithms/hrnet.md rename to docs/en/papers/algorithms/hrnet.md diff --git a/docs/papers/algorithms/hrnetv2.md b/docs/en/papers/algorithms/hrnetv2.md similarity index 100% rename from docs/papers/algorithms/hrnetv2.md rename to docs/en/papers/algorithms/hrnetv2.md diff --git a/docs/papers/algorithms/internet.md b/docs/en/papers/algorithms/internet.md similarity index 100% rename from docs/papers/algorithms/internet.md rename to docs/en/papers/algorithms/internet.md diff --git a/docs/papers/algorithms/litehrnet.md b/docs/en/papers/algorithms/litehrnet.md similarity index 100% rename from docs/papers/algorithms/litehrnet.md rename to docs/en/papers/algorithms/litehrnet.md diff --git a/docs/papers/algorithms/mspn.md b/docs/en/papers/algorithms/mspn.md similarity index 100% rename from docs/papers/algorithms/mspn.md rename to docs/en/papers/algorithms/mspn.md diff --git a/docs/papers/algorithms/posewarper.md b/docs/en/papers/algorithms/posewarper.md similarity index 100% rename from docs/papers/algorithms/posewarper.md rename to docs/en/papers/algorithms/posewarper.md diff --git a/docs/papers/algorithms/rsn.md b/docs/en/papers/algorithms/rsn.md similarity index 100% rename from docs/papers/algorithms/rsn.md rename to docs/en/papers/algorithms/rsn.md diff --git a/docs/papers/algorithms/scnet.md b/docs/en/papers/algorithms/scnet.md similarity index 100% rename from docs/papers/algorithms/scnet.md rename to docs/en/papers/algorithms/scnet.md diff --git a/docs/papers/algorithms/simplebaseline2d.md b/docs/en/papers/algorithms/simplebaseline2d.md similarity index 100% rename from docs/papers/algorithms/simplebaseline2d.md rename to docs/en/papers/algorithms/simplebaseline2d.md diff --git a/docs/papers/algorithms/simplebaseline3d.md b/docs/en/papers/algorithms/simplebaseline3d.md similarity index 100% rename from docs/papers/algorithms/simplebaseline3d.md rename to docs/en/papers/algorithms/simplebaseline3d.md diff --git a/docs/papers/algorithms/udp.md b/docs/en/papers/algorithms/udp.md similarity index 100% rename from docs/papers/algorithms/udp.md rename to docs/en/papers/algorithms/udp.md diff --git a/docs/papers/algorithms/videopose3d.md b/docs/en/papers/algorithms/videopose3d.md similarity index 100% rename from docs/papers/algorithms/videopose3d.md rename to docs/en/papers/algorithms/videopose3d.md diff --git a/docs/papers/algorithms/vipnas.md b/docs/en/papers/algorithms/vipnas.md similarity index 100% rename from docs/papers/algorithms/vipnas.md rename to docs/en/papers/algorithms/vipnas.md diff --git a/docs/papers/algorithms/wingloss.md b/docs/en/papers/algorithms/wingloss.md similarity index 100% rename from docs/papers/algorithms/wingloss.md rename to docs/en/papers/algorithms/wingloss.md diff --git a/docs/papers/backbones/alexnet.md b/docs/en/papers/backbones/alexnet.md similarity index 100% rename from docs/papers/backbones/alexnet.md rename to docs/en/papers/backbones/alexnet.md diff --git a/docs/papers/backbones/cpm.md b/docs/en/papers/backbones/cpm.md similarity index 100% rename from docs/papers/backbones/cpm.md rename to docs/en/papers/backbones/cpm.md diff --git a/docs/papers/backbones/higherhrnet.md b/docs/en/papers/backbones/higherhrnet.md similarity index 100% rename from docs/papers/backbones/higherhrnet.md rename to docs/en/papers/backbones/higherhrnet.md diff --git a/docs/papers/backbones/hourglass.md b/docs/en/papers/backbones/hourglass.md similarity index 100% rename from docs/papers/backbones/hourglass.md rename to docs/en/papers/backbones/hourglass.md diff --git a/docs/papers/backbones/hrnet.md b/docs/en/papers/backbones/hrnet.md similarity index 100% rename from docs/papers/backbones/hrnet.md rename to docs/en/papers/backbones/hrnet.md diff --git a/docs/papers/backbones/hrnetv2.md b/docs/en/papers/backbones/hrnetv2.md similarity index 100% rename from docs/papers/backbones/hrnetv2.md rename to docs/en/papers/backbones/hrnetv2.md diff --git a/docs/papers/backbones/litehrnet.md b/docs/en/papers/backbones/litehrnet.md similarity index 100% rename from docs/papers/backbones/litehrnet.md rename to docs/en/papers/backbones/litehrnet.md diff --git a/docs/papers/backbones/mobilenetv2.md b/docs/en/papers/backbones/mobilenetv2.md similarity index 100% rename from docs/papers/backbones/mobilenetv2.md rename to docs/en/papers/backbones/mobilenetv2.md diff --git a/docs/papers/backbones/mspn.md b/docs/en/papers/backbones/mspn.md similarity index 100% rename from docs/papers/backbones/mspn.md rename to docs/en/papers/backbones/mspn.md diff --git a/docs/papers/backbones/resnest.md b/docs/en/papers/backbones/resnest.md similarity index 100% rename from docs/papers/backbones/resnest.md rename to docs/en/papers/backbones/resnest.md diff --git a/docs/papers/backbones/resnet.md b/docs/en/papers/backbones/resnet.md similarity index 100% rename from docs/papers/backbones/resnet.md rename to docs/en/papers/backbones/resnet.md diff --git a/docs/papers/backbones/resnetv1d.md b/docs/en/papers/backbones/resnetv1d.md similarity index 100% rename from docs/papers/backbones/resnetv1d.md rename to docs/en/papers/backbones/resnetv1d.md diff --git a/docs/papers/backbones/resnext.md b/docs/en/papers/backbones/resnext.md similarity index 100% rename from docs/papers/backbones/resnext.md rename to docs/en/papers/backbones/resnext.md diff --git a/docs/papers/backbones/rsn.md b/docs/en/papers/backbones/rsn.md similarity index 100% rename from docs/papers/backbones/rsn.md rename to docs/en/papers/backbones/rsn.md diff --git a/docs/papers/backbones/scnet.md b/docs/en/papers/backbones/scnet.md similarity index 100% rename from docs/papers/backbones/scnet.md rename to docs/en/papers/backbones/scnet.md diff --git a/docs/papers/backbones/seresnet.md b/docs/en/papers/backbones/seresnet.md similarity index 100% rename from docs/papers/backbones/seresnet.md rename to docs/en/papers/backbones/seresnet.md diff --git a/docs/papers/backbones/shufflenetv1.md b/docs/en/papers/backbones/shufflenetv1.md similarity index 100% rename from docs/papers/backbones/shufflenetv1.md rename to docs/en/papers/backbones/shufflenetv1.md diff --git a/docs/papers/backbones/shufflenetv2.md b/docs/en/papers/backbones/shufflenetv2.md similarity index 100% rename from docs/papers/backbones/shufflenetv2.md rename to docs/en/papers/backbones/shufflenetv2.md diff --git a/docs/papers/backbones/vgg.md b/docs/en/papers/backbones/vgg.md similarity index 100% rename from docs/papers/backbones/vgg.md rename to docs/en/papers/backbones/vgg.md diff --git a/docs/papers/backbones/vipnas.md b/docs/en/papers/backbones/vipnas.md similarity index 100% rename from docs/papers/backbones/vipnas.md rename to docs/en/papers/backbones/vipnas.md diff --git a/docs/papers/datasets/300w.md b/docs/en/papers/datasets/300w.md similarity index 100% rename from docs/papers/datasets/300w.md rename to docs/en/papers/datasets/300w.md diff --git a/docs/papers/datasets/aflw.md b/docs/en/papers/datasets/aflw.md similarity index 100% rename from docs/papers/datasets/aflw.md rename to docs/en/papers/datasets/aflw.md diff --git a/docs/papers/datasets/aic.md b/docs/en/papers/datasets/aic.md similarity index 100% rename from docs/papers/datasets/aic.md rename to docs/en/papers/datasets/aic.md diff --git a/docs/papers/datasets/animalpose.md b/docs/en/papers/datasets/animalpose.md similarity index 100% rename from docs/papers/datasets/animalpose.md rename to docs/en/papers/datasets/animalpose.md diff --git a/docs/papers/datasets/ap10k.md b/docs/en/papers/datasets/ap10k.md similarity index 100% rename from docs/papers/datasets/ap10k.md rename to docs/en/papers/datasets/ap10k.md diff --git a/docs/papers/datasets/atrw.md b/docs/en/papers/datasets/atrw.md similarity index 100% rename from docs/papers/datasets/atrw.md rename to docs/en/papers/datasets/atrw.md diff --git a/docs/papers/datasets/coco.md b/docs/en/papers/datasets/coco.md similarity index 100% rename from docs/papers/datasets/coco.md rename to docs/en/papers/datasets/coco.md diff --git a/docs/papers/datasets/coco_wholebody.md b/docs/en/papers/datasets/coco_wholebody.md similarity index 100% rename from docs/papers/datasets/coco_wholebody.md rename to docs/en/papers/datasets/coco_wholebody.md diff --git a/docs/papers/datasets/coco_wholebody_face.md b/docs/en/papers/datasets/coco_wholebody_face.md similarity index 100% rename from docs/papers/datasets/coco_wholebody_face.md rename to docs/en/papers/datasets/coco_wholebody_face.md diff --git a/docs/papers/datasets/coco_wholebody_hand.md b/docs/en/papers/datasets/coco_wholebody_hand.md similarity index 100% rename from docs/papers/datasets/coco_wholebody_hand.md rename to docs/en/papers/datasets/coco_wholebody_hand.md diff --git a/docs/papers/datasets/cofw.md b/docs/en/papers/datasets/cofw.md similarity index 100% rename from docs/papers/datasets/cofw.md rename to docs/en/papers/datasets/cofw.md diff --git a/docs/papers/datasets/crowdpose.md b/docs/en/papers/datasets/crowdpose.md similarity index 100% rename from docs/papers/datasets/crowdpose.md rename to docs/en/papers/datasets/crowdpose.md diff --git a/docs/papers/datasets/deepfashion.md b/docs/en/papers/datasets/deepfashion.md similarity index 100% rename from docs/papers/datasets/deepfashion.md rename to docs/en/papers/datasets/deepfashion.md diff --git a/docs/papers/datasets/fly.md b/docs/en/papers/datasets/fly.md similarity index 100% rename from docs/papers/datasets/fly.md rename to docs/en/papers/datasets/fly.md diff --git a/docs/papers/datasets/freihand.md b/docs/en/papers/datasets/freihand.md similarity index 100% rename from docs/papers/datasets/freihand.md rename to docs/en/papers/datasets/freihand.md diff --git a/docs/papers/datasets/h36m.md b/docs/en/papers/datasets/h36m.md similarity index 100% rename from docs/papers/datasets/h36m.md rename to docs/en/papers/datasets/h36m.md diff --git a/docs/papers/datasets/halpe.md b/docs/en/papers/datasets/halpe.md similarity index 100% rename from docs/papers/datasets/halpe.md rename to docs/en/papers/datasets/halpe.md diff --git a/docs/papers/datasets/horse10.md b/docs/en/papers/datasets/horse10.md similarity index 100% rename from docs/papers/datasets/horse10.md rename to docs/en/papers/datasets/horse10.md diff --git a/docs/papers/datasets/interhand.md b/docs/en/papers/datasets/interhand.md similarity index 100% rename from docs/papers/datasets/interhand.md rename to docs/en/papers/datasets/interhand.md diff --git a/docs/papers/datasets/jhmdb.md b/docs/en/papers/datasets/jhmdb.md similarity index 100% rename from docs/papers/datasets/jhmdb.md rename to docs/en/papers/datasets/jhmdb.md diff --git a/docs/papers/datasets/locust.md b/docs/en/papers/datasets/locust.md similarity index 100% rename from docs/papers/datasets/locust.md rename to docs/en/papers/datasets/locust.md diff --git a/docs/papers/datasets/macaque.md b/docs/en/papers/datasets/macaque.md similarity index 100% rename from docs/papers/datasets/macaque.md rename to docs/en/papers/datasets/macaque.md diff --git a/docs/papers/datasets/mhp.md b/docs/en/papers/datasets/mhp.md similarity index 100% rename from docs/papers/datasets/mhp.md rename to docs/en/papers/datasets/mhp.md diff --git a/docs/papers/datasets/mpi_inf_3dhp.md b/docs/en/papers/datasets/mpi_inf_3dhp.md similarity index 100% rename from docs/papers/datasets/mpi_inf_3dhp.md rename to docs/en/papers/datasets/mpi_inf_3dhp.md diff --git a/docs/papers/datasets/mpii.md b/docs/en/papers/datasets/mpii.md similarity index 100% rename from docs/papers/datasets/mpii.md rename to docs/en/papers/datasets/mpii.md diff --git a/docs/papers/datasets/mpii_trb.md b/docs/en/papers/datasets/mpii_trb.md similarity index 100% rename from docs/papers/datasets/mpii_trb.md rename to docs/en/papers/datasets/mpii_trb.md diff --git a/docs/papers/datasets/ochuman.md b/docs/en/papers/datasets/ochuman.md similarity index 100% rename from docs/papers/datasets/ochuman.md rename to docs/en/papers/datasets/ochuman.md diff --git a/docs/papers/datasets/onehand10k.md b/docs/en/papers/datasets/onehand10k.md similarity index 100% rename from docs/papers/datasets/onehand10k.md rename to docs/en/papers/datasets/onehand10k.md diff --git a/docs/papers/datasets/panoptic.md b/docs/en/papers/datasets/panoptic.md similarity index 100% rename from docs/papers/datasets/panoptic.md rename to docs/en/papers/datasets/panoptic.md diff --git a/docs/papers/datasets/posetrack18.md b/docs/en/papers/datasets/posetrack18.md similarity index 100% rename from docs/papers/datasets/posetrack18.md rename to docs/en/papers/datasets/posetrack18.md diff --git a/docs/papers/datasets/rhd.md b/docs/en/papers/datasets/rhd.md similarity index 100% rename from docs/papers/datasets/rhd.md rename to docs/en/papers/datasets/rhd.md diff --git a/docs/papers/datasets/wflw.md b/docs/en/papers/datasets/wflw.md similarity index 100% rename from docs/papers/datasets/wflw.md rename to docs/en/papers/datasets/wflw.md diff --git a/docs/papers/datasets/zebra.md b/docs/en/papers/datasets/zebra.md similarity index 100% rename from docs/papers/datasets/zebra.md rename to docs/en/papers/datasets/zebra.md diff --git a/docs/papers/techniques/albumentations.md b/docs/en/papers/techniques/albumentations.md similarity index 100% rename from docs/papers/techniques/albumentations.md rename to docs/en/papers/techniques/albumentations.md diff --git a/docs/papers/techniques/dark.md b/docs/en/papers/techniques/dark.md similarity index 100% rename from docs/papers/techniques/dark.md rename to docs/en/papers/techniques/dark.md diff --git a/docs/papers/techniques/fp16.md b/docs/en/papers/techniques/fp16.md similarity index 100% rename from docs/papers/techniques/fp16.md rename to docs/en/papers/techniques/fp16.md diff --git a/docs/papers/techniques/udp.md b/docs/en/papers/techniques/udp.md similarity index 100% rename from docs/papers/techniques/udp.md rename to docs/en/papers/techniques/udp.md diff --git a/docs/papers/techniques/wingloss.md b/docs/en/papers/techniques/wingloss.md similarity index 100% rename from docs/papers/techniques/wingloss.md rename to docs/en/papers/techniques/wingloss.md diff --git a/docs/stats.py b/docs/en/stats.py similarity index 100% rename from docs/stats.py rename to docs/en/stats.py diff --git a/docs/tasks/2d_animal_keypoint.md b/docs/en/tasks/2d_animal_keypoint.md similarity index 100% rename from docs/tasks/2d_animal_keypoint.md rename to docs/en/tasks/2d_animal_keypoint.md diff --git a/docs/tasks/2d_body_keypoint.md b/docs/en/tasks/2d_body_keypoint.md similarity index 100% rename from docs/tasks/2d_body_keypoint.md rename to docs/en/tasks/2d_body_keypoint.md diff --git a/docs/tasks/2d_face_keypoint.md b/docs/en/tasks/2d_face_keypoint.md similarity index 100% rename from docs/tasks/2d_face_keypoint.md rename to docs/en/tasks/2d_face_keypoint.md diff --git a/docs/tasks/2d_fashion_landmark.md b/docs/en/tasks/2d_fashion_landmark.md similarity index 100% rename from docs/tasks/2d_fashion_landmark.md rename to docs/en/tasks/2d_fashion_landmark.md diff --git a/docs/tasks/2d_hand_keypoint.md b/docs/en/tasks/2d_hand_keypoint.md similarity index 100% rename from docs/tasks/2d_hand_keypoint.md rename to docs/en/tasks/2d_hand_keypoint.md diff --git a/docs/tasks/2d_wholebody_keypoint.md b/docs/en/tasks/2d_wholebody_keypoint.md similarity index 100% rename from docs/tasks/2d_wholebody_keypoint.md rename to docs/en/tasks/2d_wholebody_keypoint.md diff --git a/docs/tasks/3d_body_keypoint.md b/docs/en/tasks/3d_body_keypoint.md similarity index 95% rename from docs/tasks/3d_body_keypoint.md rename to docs/en/tasks/3d_body_keypoint.md index 2b19df73959..4c9b2dd0123 100644 --- a/docs/tasks/3d_body_keypoint.md +++ b/docs/en/tasks/3d_body_keypoint.md @@ -72,4 +72,4 @@ mmpose `── S11 ``` -Please note that Human3.6M dataset is also used in the [3D_body_mesh](/docs/tasks/3d_body_mesh.md) task, where different schemes for data preprocessing and organizing are adopted. +Please note that Human3.6M dataset is also used in the [3D_body_mesh](/docs/en/tasks/3d_body_mesh.md) task, where different schemes for data preprocessing and organizing are adopted. diff --git a/docs/tasks/3d_body_mesh.md b/docs/en/tasks/3d_body_mesh.md similarity index 100% rename from docs/tasks/3d_body_mesh.md rename to docs/en/tasks/3d_body_mesh.md diff --git a/docs/tasks/3d_hand_keypoint.md b/docs/en/tasks/3d_hand_keypoint.md similarity index 100% rename from docs/tasks/3d_hand_keypoint.md rename to docs/en/tasks/3d_hand_keypoint.md diff --git a/docs/tutorials/0_config.md b/docs/en/tutorials/0_config.md similarity index 100% rename from docs/tutorials/0_config.md rename to docs/en/tutorials/0_config.md diff --git a/docs/tutorials/1_finetune.md b/docs/en/tutorials/1_finetune.md similarity index 100% rename from docs/tutorials/1_finetune.md rename to docs/en/tutorials/1_finetune.md diff --git a/docs/tutorials/2_new_dataset.md b/docs/en/tutorials/2_new_dataset.md similarity index 100% rename from docs/tutorials/2_new_dataset.md rename to docs/en/tutorials/2_new_dataset.md diff --git a/docs/tutorials/3_data_pipeline.md b/docs/en/tutorials/3_data_pipeline.md similarity index 100% rename from docs/tutorials/3_data_pipeline.md rename to docs/en/tutorials/3_data_pipeline.md diff --git a/docs/tutorials/4_new_modules.md b/docs/en/tutorials/4_new_modules.md similarity index 100% rename from docs/tutorials/4_new_modules.md rename to docs/en/tutorials/4_new_modules.md diff --git a/docs/tutorials/5_export_model.md b/docs/en/tutorials/5_export_model.md similarity index 100% rename from docs/tutorials/5_export_model.md rename to docs/en/tutorials/5_export_model.md diff --git a/docs/tutorials/6_customize_runtime.md b/docs/en/tutorials/6_customize_runtime.md similarity index 100% rename from docs/tutorials/6_customize_runtime.md rename to docs/en/tutorials/6_customize_runtime.md diff --git a/docs/useful_tools.md b/docs/en/useful_tools.md similarity index 100% rename from docs/useful_tools.md rename to docs/en/useful_tools.md diff --git a/docs_zh-CN/Makefile b/docs/zh_cn/Makefile similarity index 100% rename from docs_zh-CN/Makefile rename to docs/zh_cn/Makefile diff --git a/docs_zh-CN/_static/css/readthedocs.css b/docs/zh_cn/_static/css/readthedocs.css similarity index 100% rename from docs_zh-CN/_static/css/readthedocs.css rename to docs/zh_cn/_static/css/readthedocs.css diff --git a/docs_zh-CN/_static/images/mmpose-logo.png b/docs/zh_cn/_static/images/mmpose-logo.png similarity index 100% rename from docs_zh-CN/_static/images/mmpose-logo.png rename to docs/zh_cn/_static/images/mmpose-logo.png diff --git a/docs_zh-CN/api.rst b/docs/zh_cn/api.rst similarity index 100% rename from docs_zh-CN/api.rst rename to docs/zh_cn/api.rst diff --git a/docs_zh-CN/benchmark.md b/docs/zh_cn/benchmark.md similarity index 100% rename from docs_zh-CN/benchmark.md rename to docs/zh_cn/benchmark.md diff --git a/docs_zh-CN/collect.py b/docs/zh_cn/collect.py similarity index 90% rename from docs_zh-CN/collect.py rename to docs/zh_cn/collect.py index 96e1ccdbe57..5f8aedee061 100755 --- a/docs_zh-CN/collect.py +++ b/docs/zh_cn/collect.py @@ -11,7 +11,7 @@ # Step 1: get subtopics: a mix of topic and task minisections = [ - x.split('/')[-2:] for x in glob('../configs/*/*') if '_base_' not in x + x.split('/')[-2:] for x in glob('../../configs/*/*') if '_base_' not in x ] alltopics = sorted(list(set(x[0] for x in minisections))) subtopics = [] @@ -36,11 +36,11 @@ list( set( x.split('/')[-2] - for x in glob(f'../configs/{topic}/{task}/*/*/')))) + for x in glob(f'../../configs/{topic}/{task}/*/*/')))) contents[subtopic] = {d: {} for d in datasets} for dataset in datasets: # Step 3: get all settings: algorithm + backbone + trick - for file in glob(f'../configs/{topic}/{task}/*/{dataset}/*.md'): + for file in glob(f'../../configs/{topic}/{task}/*/{dataset}/*.md'): keywords = (file.split('/')[-3], *file.split('/')[-1].split('_')[:-1]) with open(file, 'r') as f: @@ -67,13 +67,13 @@ f.write('\n'.join(lines)) # Step 5: write files by paper -allfiles = [x.split('/')[-2:] for x in glob('../docs/papers/*/*.md')] +allfiles = [x.split('/')[-2:] for x in glob('../en/papers/*/*.md')] sections = sorted(list(set(x[0] for x in allfiles))) for section in sections: lines = [f'# {titlecase(section)}', ''] files = [f for s, f in allfiles if s == section] for file in files: - with open(f'../docs/papers/{section}/{file}', 'r') as f: + with open(f'../en/papers/{section}/{file}', 'r') as f: keyline = [ line for line in f.readlines() if line.startswith('>> when copying code +copybutton_prompt_text = r'>>> |\.\.\. ' +copybutton_prompt_is_regexp = True + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# -- Options for HTML output ------------------------------------------------- +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'pytorch_sphinx_theme' +html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()] +html_theme_options = { + 'menu': [{ + 'name': + '教程', + 'url': + 'https://colab.research.google.com/github/' + 'open-mmlab/mmpose/blob/master/demo/MMPose_Tutorial.ipynb' + }, { + 'name': 'GitHub', + 'url': 'https://github.com/open-mmlab/mmpose' + }], + 'menu_lang': + 'cn' +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". + +language = 'zh_CN' + +html_static_path = ['_static'] +html_css_files = ['css/readthedocs.css'] + +# Enable ::: for my_st +myst_enable_extensions = ['colon_fence'] + +master_doc = 'index' + + +def builder_inited_handler(app): + subprocess.run(['./collect.py']) + subprocess.run(['./merge_docs.sh']) + subprocess.run(['./stats.py']) + + +def setup(app): + app.connect('builder-inited', builder_inited_handler) diff --git a/docs_zh-CN/data_preparation.md b/docs/zh_cn/data_preparation.md similarity index 100% rename from docs_zh-CN/data_preparation.md rename to docs/zh_cn/data_preparation.md diff --git a/docs_zh-CN/faq.md b/docs/zh_cn/faq.md similarity index 100% rename from docs_zh-CN/faq.md rename to docs/zh_cn/faq.md diff --git a/docs_zh-CN/getting_started.md b/docs/zh_cn/getting_started.md similarity index 93% rename from docs_zh-CN/getting_started.md rename to docs/zh_cn/getting_started.md index 34156d778c6..5fd0d746224 100644 --- a/docs_zh-CN/getting_started.md +++ b/docs/zh_cn/getting_started.md @@ -22,15 +22,15 @@ MMPose 支持各种不同的任务。请根据需要，查阅对应的数据集准备教程。 -- [2D 人体关键点检测](/docs/tasks/2d_body_keypoint.md) -- [3D 人体关键点检测](/docs/tasks/3d_body_keypoint.md) -- [3D 人体形状恢复](/docs/tasks/3d_body_mesh.md) -- [2D 人手关键点检测](/docs/tasks/2d_hand_keypoint.md) -- [3D 人手关键点检测](/docs/tasks/3d_hand_keypoint.md) -- [2D 人脸关键点检测](/docs/tasks/2d_face_keypoint.md) -- [2D 全身人体关键点检测](/docs/tasks/2d_wholebody_keypoint.md) -- [2D 服饰关键点检测](/docs/tasks/2d_fashion_landmark.md) -- [2D 动物关键点检测](/docs/tasks/2d_animal_keypoint.md) +- [2D 人体关键点检测](/docs/zh_cn/tasks/2d_body_keypoint.md) +- [3D 人体关键点检测](/docs/zh_cn/tasks/3d_body_keypoint.md) +- [3D 人体形状恢复](/docs/zh_cn/tasks/3d_body_mesh.md) +- [2D 人手关键点检测](/docs/zh_cn/tasks/2d_hand_keypoint.md) +- [3D 人手关键点检测](/docs/zh_cn/tasks/3d_hand_keypoint.md) +- [2D 人脸关键点检测](/docs/zh_cn/tasks/2d_face_keypoint.md) +- [2D 全身人体关键点检测](/docs/zh_cn/tasks/2d_wholebody_keypoint.md) +- [2D 服饰关键点检测](/docs/zh_cn/tasks/2d_fashion_landmark.md) +- [2D 动物关键点检测](/docs/zh_cn/tasks/2d_animal_keypoint.md) ## 使用预训练模型进行推理 @@ -202,7 +202,7 @@ GPUS=16 GPUS_PER_NODE=8 CPUS_PER_TASK=2 ./tools/slurm_train.sh Test res50 config 用户可以查看 [slurm_train.sh](/tools/slurm_train.sh) 文件来检查完整的参数和环境变量。 -如果用户的多台机器通过 Ethernet 连接，则可以参考 pytorch [launch utility](https://pytorch.org/docs/stable/distributed.html#launch-utility)。如果用户没有高速网络，如 InfiniBand，速度将会非常慢。 +如果用户的多台机器通过 Ethernet 连接，则可以参考 pytorch [launch utility](https://pytorch.org/docs/en/stable/distributed.html#launch-utility)。如果用户没有高速网络，如 InfiniBand，速度将会非常慢。 ### 使用单台机器启动多个任务 diff --git a/docs_zh-CN/imgs/acc_curve.png b/docs/zh_cn/imgs/acc_curve.png similarity index 100% rename from docs_zh-CN/imgs/acc_curve.png rename to docs/zh_cn/imgs/acc_curve.png diff --git a/docs_zh-CN/imgs/qq_group_qrcode.jpg b/docs/zh_cn/imgs/qq_group_qrcode.jpg similarity index 100% rename from docs_zh-CN/imgs/qq_group_qrcode.jpg rename to docs/zh_cn/imgs/qq_group_qrcode.jpg diff --git a/docs_zh-CN/imgs/zhihu_qrcode.jpg b/docs/zh_cn/imgs/zhihu_qrcode.jpg similarity index 100% rename from docs_zh-CN/imgs/zhihu_qrcode.jpg rename to docs/zh_cn/imgs/zhihu_qrcode.jpg diff --git a/docs_zh-CN/index.rst b/docs/zh_cn/index.rst similarity index 98% rename from docs_zh-CN/index.rst rename to docs/zh_cn/index.rst index d24962b1260..244266c8ddd 100644 --- a/docs_zh-CN/index.rst +++ b/docs/zh_cn/index.rst @@ -36,6 +36,7 @@ You can change the documentation language at the lower-left corner of the page. modelzoo.md topics/animal.md topics/body(2d,kpt,img).md + topics/body(2d,kpt,vid).md topics/body(3d,kpt,img).md topics/body(3d,kpt,vid).md topics/body(3d,mesh,img).md diff --git a/docs_zh-CN/inference_speed_summary.md b/docs/zh_cn/inference_speed_summary.md similarity index 100% rename from docs_zh-CN/inference_speed_summary.md rename to docs/zh_cn/inference_speed_summary.md diff --git a/docs_zh-CN/install.md b/docs/zh_cn/install.md similarity index 100% rename from docs_zh-CN/install.md rename to docs/zh_cn/install.md diff --git a/docs_zh-CN/language.md b/docs/zh_cn/language.md similarity index 100% rename from docs_zh-CN/language.md rename to docs/zh_cn/language.md diff --git a/docs_zh-CN/make.bat b/docs/zh_cn/make.bat similarity index 100% rename from docs_zh-CN/make.bat rename to docs/zh_cn/make.bat diff --git a/docs_zh-CN/merge_docs.sh b/docs/zh_cn/merge_docs.sh similarity index 57% rename from docs_zh-CN/merge_docs.sh rename to docs/zh_cn/merge_docs.sh index d1596ec99b9..51fc8bc84f2 100755 --- a/docs_zh-CN/merge_docs.sh +++ b/docs/zh_cn/merge_docs.sh @@ -1,20 +1,20 @@ #!/usr/bin/env bash # Copyright (c) OpenMMLab. All rights reserved. -sed -i '$a\\n' ../demo/docs/*_demo.md -cat ../demo/docs/*_demo.md | sed "s/#/#&/" | sed "s/md###t/html#t/g" | sed '1i\# 示例' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmpose/tree/master/=g' >demo.md +sed -i '$a\\n' ../../demo/docs/*_demo.md +cat ../../demo/docs/*_demo.md | sed "s/#/#&/" | sed "s/md###t/html#t/g" | sed '1i\# 示例' | sed 's=](/docs/zh_cn/=](/=g' | sed 's=](/=](https://github.com/open-mmlab/mmpose/tree/master/=g' >demo.md # remove /docs_zh-CN/ for link used in doc site -sed -i 's/](\/docs_zh-CN\//](/g' ./tutorials/*.md -sed -i 's/](\/docs_zh-CN\//](/g' ./tasks/*.md -sed -i 's/](\/docs_zh-CN\//](/g' ./papers/*.md -sed -i 's/](\/docs_zh-CN\//](/g' ./topics/*.md -sed -i 's/](\/docs_zh-CN\//](/g' data_preparation.md -sed -i 's/](\/docs_zh-CN\//](/g' getting_started.md -sed -i 's/](\/docs_zh-CN\//](/g' install.md -sed -i 's/](\/docs_zh-CN\//](/g' benchmark.md -# sed -i 's/](\/docs_zh-CN\//](/g' changelog.md -sed -i 's/](\/docs_zh-CN\//](/g' faq.md +sed -i 's=](/docs/zh_cn/=](=g' ./tutorials/*.md +sed -i 's=](/docs/zh_cn/=](=g' ./tasks/*.md +sed -i 's=](/docs/zh_cn/=](=g' ./papers/*.md +sed -i 's=](/docs/zh_cn/=](=g' ./topics/*.md +sed -i 's=](/docs/zh_cn/=](=g' data_preparation.md +sed -i 's=](/docs/zh_cn/=](=g' getting_started.md +sed -i 's=](/docs/zh_cn/=](=g' install.md +sed -i 's=](/docs/zh_cn/=](=g' benchmark.md +# sed -i 's=](/docs/zh_cn/=](=g' changelog.md +sed -i 's=](/docs/zh_cn/=](=g' faq.md sed -i 's=](/=](https://github.com/open-mmlab/mmpose/tree/master/=g' ./tutorials/*.md sed -i 's=](/=](https://github.com/open-mmlab/mmpose/tree/master/=g' ./tasks/*.md diff --git a/docs_zh-CN/stats.py b/docs/zh_cn/stats.py similarity index 100% rename from docs_zh-CN/stats.py rename to docs/zh_cn/stats.py diff --git a/docs_zh-CN/tasks/2d_animal_keypoint.md b/docs/zh_cn/tasks/2d_animal_keypoint.md similarity index 100% rename from docs_zh-CN/tasks/2d_animal_keypoint.md rename to docs/zh_cn/tasks/2d_animal_keypoint.md diff --git a/docs_zh-CN/tasks/2d_body_keypoint.md b/docs/zh_cn/tasks/2d_body_keypoint.md similarity index 100% rename from docs_zh-CN/tasks/2d_body_keypoint.md rename to docs/zh_cn/tasks/2d_body_keypoint.md diff --git a/docs_zh-CN/tasks/2d_face_keypoint.md b/docs/zh_cn/tasks/2d_face_keypoint.md similarity index 100% rename from docs_zh-CN/tasks/2d_face_keypoint.md rename to docs/zh_cn/tasks/2d_face_keypoint.md diff --git a/docs_zh-CN/tasks/2d_fashion_landmark.md b/docs/zh_cn/tasks/2d_fashion_landmark.md similarity index 100% rename from docs_zh-CN/tasks/2d_fashion_landmark.md rename to docs/zh_cn/tasks/2d_fashion_landmark.md diff --git a/docs_zh-CN/tasks/2d_hand_keypoint.md b/docs/zh_cn/tasks/2d_hand_keypoint.md similarity index 100% rename from docs_zh-CN/tasks/2d_hand_keypoint.md rename to docs/zh_cn/tasks/2d_hand_keypoint.md diff --git a/docs_zh-CN/tasks/2d_wholebody_keypoint.md b/docs/zh_cn/tasks/2d_wholebody_keypoint.md similarity index 100% rename from docs_zh-CN/tasks/2d_wholebody_keypoint.md rename to docs/zh_cn/tasks/2d_wholebody_keypoint.md diff --git a/docs_zh-CN/tasks/3d_body_keypoint.md b/docs/zh_cn/tasks/3d_body_keypoint.md similarity index 100% rename from docs_zh-CN/tasks/3d_body_keypoint.md rename to docs/zh_cn/tasks/3d_body_keypoint.md diff --git a/docs_zh-CN/tasks/3d_body_mesh.md b/docs/zh_cn/tasks/3d_body_mesh.md similarity index 100% rename from docs_zh-CN/tasks/3d_body_mesh.md rename to docs/zh_cn/tasks/3d_body_mesh.md diff --git a/docs_zh-CN/tasks/3d_hand_keypoint.md b/docs/zh_cn/tasks/3d_hand_keypoint.md similarity index 100% rename from docs_zh-CN/tasks/3d_hand_keypoint.md rename to docs/zh_cn/tasks/3d_hand_keypoint.md diff --git a/docs_zh-CN/tutorials/0_config.md b/docs/zh_cn/tutorials/0_config.md similarity index 100% rename from docs_zh-CN/tutorials/0_config.md rename to docs/zh_cn/tutorials/0_config.md diff --git a/docs_zh-CN/tutorials/1_finetune.md b/docs/zh_cn/tutorials/1_finetune.md similarity index 100% rename from docs_zh-CN/tutorials/1_finetune.md rename to docs/zh_cn/tutorials/1_finetune.md diff --git a/docs_zh-CN/tutorials/2_new_dataset.md b/docs/zh_cn/tutorials/2_new_dataset.md similarity index 100% rename from docs_zh-CN/tutorials/2_new_dataset.md rename to docs/zh_cn/tutorials/2_new_dataset.md diff --git a/docs_zh-CN/tutorials/3_data_pipeline.md b/docs/zh_cn/tutorials/3_data_pipeline.md similarity index 100% rename from docs_zh-CN/tutorials/3_data_pipeline.md rename to docs/zh_cn/tutorials/3_data_pipeline.md diff --git a/docs_zh-CN/tutorials/4_new_modules.md b/docs/zh_cn/tutorials/4_new_modules.md similarity index 100% rename from docs_zh-CN/tutorials/4_new_modules.md rename to docs/zh_cn/tutorials/4_new_modules.md diff --git a/docs_zh-CN/tutorials/5_export_model.md b/docs/zh_cn/tutorials/5_export_model.md similarity index 100% rename from docs_zh-CN/tutorials/5_export_model.md rename to docs/zh_cn/tutorials/5_export_model.md diff --git a/docs_zh-CN/tutorials/6_customize_runtime.md b/docs/zh_cn/tutorials/6_customize_runtime.md similarity index 100% rename from docs_zh-CN/tutorials/6_customize_runtime.md rename to docs/zh_cn/tutorials/6_customize_runtime.md diff --git a/docs_zh-CN/useful_tools.md b/docs/zh_cn/useful_tools.md similarity index 100% rename from docs_zh-CN/useful_tools.md rename to docs/zh_cn/useful_tools.md diff --git a/docs_zh-CN/conf.py b/docs_zh-CN/conf.py deleted file mode 100644 index e180886db35..00000000000 --- a/docs_zh-CN/conf.py +++ /dev/null @@ -1,187 +0,0 @@ -# Copyright (c) OpenMMLab. All rights reserved. -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import subprocess -import sys - -import pytorch_sphinx_theme - -sys.path.insert(0, os.path.abspath('..')) - -# -- Project information ----------------------------------------------------- - -project = 'MMPose' -copyright = '2020-2021, OpenMMLab' -author = 'MMPose Authors' - -# The full version, including alpha/beta/rc tags -version_file = '../mmpose/version.py' - - -def get_version(): - with open(version_file, 'r') as f: - exec(compile(f.read(), version_file, 'exec')) - return locals()['__version__'] - - -release = get_version() - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', - 'sphinx_markdown_tables', 'sphinx_copybutton', 'myst_parser' -] - -autodoc_mock_imports = ['json_tricks', 'mmpose.version'] - -# Ignore >>> when copying code -copybutton_prompt_text = r'>>> |\.\.\. ' -copybutton_prompt_is_regexp = True - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# -- Options for HTML output ------------------------------------------------- -source_suffix = { - '.rst': 'restructuredtext', - '.md': 'markdown', -} - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'pytorch_sphinx_theme' -html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()] -html_theme_options = { - 'menu': [ - { - 'name': - '教程', - 'url': - 'https://colab.research.google.com/github/' - 'open-mmlab/mmpose/blob/master/demo/MMPose_Tutorial.ipynb' - }, - { - 'name': 'GitHub', - 'url': 'https://github.com/open-mmlab/mmpose' - }, - { - 'name': - '算法库', - 'children': [{ - 'name': 'MMCV', - 'url': 'https://mmcv.readthedocs.io/zh_CN/latest/', - 'description': '计算机视觉基础库' - }, { - 'name': 'MMDetection', - 'url': 'https://mmdetection.readthedocs.io/zh_CN/latest/', - 'description': '检测工具箱与测试基准' - }, { - 'name': 'MMAction2', - 'url': 'https://mmaction2.readthedocs.io/zh_CN/latest/', - 'description': '视频理解工具箱与测试基准' - }, { - 'name': 'MMClassification', - 'url': 'https://mmclassification.readthedocs.io/zh_CN/latest/', - 'description': '图像分类工具箱与测试基准' - }, { - 'name': 'MMSegmentation', - 'url': 'https://mmsegmentation.readthedocs.io/zh_CN/latest/', - 'description': '语义分割工具箱与测试基准' - }, { - 'name': 'MMDetection3D', - 'url': 'https://mmdetection3d.readthedocs.io/zh_CN/latest/', - 'description': '通用3D目标检测平台' - }, { - 'name': 'MMEditing', - 'url': 'https://mmediting.readthedocs.io/zh_CN/latest/', - 'description': '图像视频编辑工具箱' - }, { - 'name': 'MMOCR', - 'url': 'https://mmocr.readthedocs.io/zh_CN/latest/', - 'description': '全流程文字检测识别理解工具包' - }, { - 'name': 'MMTracking', - 'url': 'https://mmtracking.readthedocs.io/zh_CN/latest/', - 'description': '一体化视频目标感知平台' - }, { - 'name': 'MMGeneration', - 'url': 'https://mmgeneration.readthedocs.io/en/latest/', - 'description': '生成模型工具箱' - }, { - 'name': 'MMFlow', - 'url': 'https://mmflow.readthedocs.io/en/latest/', - 'description': '光流估计工具箱与测试基准' - }, { - 'name': 'MMFewShot', - 'url': 'https://mmfewshot.readthedocs.io/zh_CN/latest/', - 'description': '少样本学习工具箱与测试基准' - }, { - 'name': 'MMHuman3D', - 'url': 'https://mmhuman3d.readthedocs.io/en/latest/', - 'description': 'OpenMMLab 人体参数化模型工具箱与测试基准.' - }] - }, - { - 'name': - 'OpenMMLab', - 'children': [{ - 'name': '主页', - 'url': 'https://openmmlab.com/' - }, { - 'name': 'GitHub', - 'url': 'https://github.com/open-mmlab/' - }, { - 'name': '推特', - 'url': 'https://twitter.com/OpenMMLab' - }, { - 'name': '知乎', - 'url': 'https://zhihu.com/people/openmmlab' - }] - }, - ] -} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". - -language = 'zh_CN' - -html_static_path = ['_static'] -html_css_files = ['css/readthedocs.css'] - -# Enable ::: for my_st -myst_enable_extensions = ['colon_fence'] - -master_doc = 'index' - - -def builder_inited_handler(app): - subprocess.run(['./collect.py']) - subprocess.run(['./merge_docs.sh']) - subprocess.run(['./stats.py']) - - -def setup(app): - app.connect('builder-inited', builder_inited_handler)