[Dox] Update for get_started. (open-mmlab#1513)

* Update table of contents for en/get_started.md * Update table of contents for zh_cn/get_started.md * Supplement the content of the benchmark. * Supplement tutorials/7_webcam_api for en/get_started.md. * fix lint Co-authored-by: ly015 <liyining0712@gmail.com>
ajgrafton · Jul 27, 2022 · 5e8f0a9 · 5e8f0a9
1 parent 10824ae
commit 5e8f0a9
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/docs/en/get_started.md b/docs/en/get_started.md
@@ -10,6 +10,7 @@ For installation instructions, please see [install.md](install.md).
   - [Test a dataset](#test-a-dataset)
   - [Run demos](#run-demos)
 - [Train a Model](#train-a-model)
+  - [Training setting](#training-setting)
   - [Train with a single GPU](#train-with-a-single-gpu)
   - [Train with CPU](#train-with-cpu)
   - [Train with multiple GPUs](#train-with-multiple-gpus)
@@ -288,4 +289,5 @@ We provide some tutorials for users:
 - [customize data pipelines](tutorials/3_data_pipeline.md)
 - [add new modules](tutorials/4_new_modules.md)
 - [export a model to ONNX](tutorials/5_export_model.md)
-- [customize runtime settings](tutorials/6_customize_runtime.md).
+- [customize runtime settings](tutorials/6_customize_runtime.md)
+- [develop applications with Webcam API](tutorials/7_webcam_api.md)
diff --git a/docs/zh_cn/get_started.md b/docs/zh_cn/get_started.md
@@ -9,6 +9,7 @@
   - [测试某个数据集](#测试某个数据集)
   - [运行演示](#运行演示)
 - [如何训练模型](#如何训练模型)
+  - [训练配置](#训练配置)
   - [使用单个 GPU 训练](#使用单个-GPU-训练)
   - [使用 CPU 训练](#使用-CPU-训练)
   - [使用多个 GPU 训练](#使用多个-GPU-训练)
@@ -267,6 +268,14 @@ CUDA_VISIBLE_DEVICES=0,1,2,3 GPUS=4 ./tools/slurm_train.sh ${PARTITION} ${JOB_NA
 CUDA_VISIBLE_DEVICES=4,5,6,7 GPUS=4 ./tools/slurm_train.sh ${PARTITION} ${JOB_NAME} config2.py [--work-dir ${WORK_DIR}]
 ```
 
+## 基准测试
+
+您可以使用以下脚本获得平均推理速度。请注意，它不包括 IO 时间和预处理时间。
+
+```shell
+python tools/analysis/benchmark_inference.py ${MMPOSE_CONFIG_FILE}
+```
+
 ## 进阶教程
 
 目前, MMPose 提供了以下更详细的教程：