add some useful tools (open-mmlab#324)

* add useful tools * update readmes for tutorials * add useful_tools.md
Spiideo · Dec 15, 2020 · 53250f5 · 53250f5
1 parent 9ce55bd
commit 53250f5
Show file tree

Hide file tree

Showing 19 changed files with 847 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -130,8 +130,9 @@ Please refer to [data_preparation.md](docs/data_preparation.md) for a general kn
 ## Get Started
 
 Please see [getting_started.md](docs/getting_started.md) for the basic usage of MMPose.
-There are also tutorials for [finetuning model](docs/tutorials/finetune.md),
-[adding new dataset](docs/tutorials/new_dataset.md), [adding new modules](docs/tutorials/new_modules.md).
+There are also tutorials: [finetune model](tutorials/1_finetune.md),
+[add new dataset](tutorials/2_new_dataset.md), [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) and [customize runtime settings](tutorials/6_customize_runtime.md).
 
 ## License
 

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -3,7 +3,25 @@
 This page provides basic tutorials about the usage of MMPose.
 For installation instructions, please see [install.md](install.md).
 
-## Prepare datasets
+
+<!-- TOC -->
+
+- [Prepare Datasets](#prepare-datasets)
+- [Inference with Pre-Trained Models](#inference-with-pre-trained-models)
+  * [Test a dataset](#test-a-dataset)
+  * [Run demos](#run-demos)
+- [Train a Model](#train-a-model)
+  * [Train with a single GPU](#train-with-a-single-gpu)
+  * [Train with multiple GPUs](#train-with-multiple-gpus)
+  * [Train with multiple machines](#train-with-multiple-machines)
+  * [Launch multiple jobs on a single machine](#launch-multiple-jobs-on-a-single-machine)
+- [Benchmark](#benchmark)
+- [Tutorials](#tutorials)
+
+<!-- TOC -->
+
+
+## Prepare Datasets
 
 MMPose supported datasets:
 
@@ -22,7 +40,7 @@ MMPose supported datasets:
 Please follow [DATA Preparation](data_preparation.md) to prepare the data.
 
 
-## Inference with pretrained models
+## Inference with Pre-trained Models
 
 We provide testing scripts to evaluate a whole dataset (COCO, etc.),
 and provide some high-level apis for easier integration to other projects.
@@ -223,5 +241,6 @@ python tools/benchmark_inference.py ${MMPOSE_CONFIG_FILE}
 
 ## Tutorials
 
-Currently, we provide some tutorials for users to [finetune model](tutorials/finetune.md),
-[add new dataset](tutorials/new_dataset.md), [add new modules](tutorials/new_modules.md).
+Currently, we provide some tutorials for users to [finetune model](tutorials/1_finetune.md),
+[add new dataset](tutorials/2_new_dataset.md), [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) and [customize runtime settings](tutorials/6_customize_runtime.md).
diff --git a/docs/imgs/acc_curve.png b/docs/imgs/acc_curve.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -31,10 +31,18 @@ Welcome to MMPose's documentation!
    :maxdepth: 2
    :caption: Tutorials
 
-   tutorials/finetune.md
-   tutorials/new_dataset.md
-   tutorials/data_pipeline.md
-   tutorials/new_modules.md
+   tutorials/1_finetune.md
+   tutorials/2_new_dataset.md
+   tutorials/3_data_pipeline.md
+   tutorials/4_new_modules.md
+   tutorials/5_export_model.md
+   tutorials/6_customize_runtime.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Useful Tools and Scripts
+
+   useful_tools.md
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/tutorials/finetune.md → docs/tutorials/1_finetune.md b/docs/tutorials/finetune.md → docs/tutorials/1_finetune.md
diff --git a/docs/tutorials/new_dataset.md → docs/tutorials/2_new_dataset.md b/docs/tutorials/new_dataset.md → docs/tutorials/2_new_dataset.md
diff --git a/docs/tutorials/data_pipeline.md → docs/tutorials/3_data_pipeline.md b/docs/tutorials/data_pipeline.md → docs/tutorials/3_data_pipeline.md
diff --git a/docs/tutorials/new_modules.md → docs/tutorials/4_new_modules.md b/docs/tutorials/new_modules.md → docs/tutorials/4_new_modules.md
diff --git a/docs/tutorials/export_model.md → docs/tutorials/5_export_model.md b/docs/tutorials/export_model.md → docs/tutorials/5_export_model.md