Update docs page

.gitlab-ci.yml

@@ -52,7 +52,7 @@ pages:
     - pip install mmcv
     - pip install sphinx sphinx_rtd_theme recommonmark sphinx-markdown-tables
     - cd docs
-    - ./add_models.sh
+    - ./merge_docs.sh
     - make html
     - cd ..
     - mkdir -p ./public

docs/config.md

@@ -17,7 +17,7 @@ We follow the style below to name config files. Contributors are advised to foll
 - `[misc]`: miscellaneous setting/plugins of model, e.g. `dense`, `2d`, `3d`, etc.
 - `{data setting}`: frame sample setting in `{clip_len}x{frame_interval}x{num_clips}` format.
 - `[gpu x batch_per_gpu]`: GPUs and samples per GPU.
-- `{schedule}`: training schedule, e.g. `20e` means 12 epochs.
+- `{schedule}`: training schedule, e.g. `20e` means 20 epochs.
 - `{dataset}`: dataset name, e.g. `kinetics400`, `mmit`, etc.
 - `{modality}`: frame modality, e.g. `rgb`, `flow`, etc.
 

docs/getting_started.md

@@ -3,7 +3,7 @@
 This page provides basic tutorials about the usage of MMAction.
 For installation instructions, please see [install.md](install.md).
 
-## Prepare Datasets
+## Datasets
 
 It is recommended to symlink the dataset root to `$MMACTION/data`.
 If your folder structure is different, you may need to change the corresponding paths in config files.

docs/index.rst

@@ -8,7 +8,6 @@ Welcome to MMAction's documentation!
    benchmark.md
    install.md
    config.md
-   parrots_start.md
    api.rst
 
 

docs/add_models.sh → docs/merge_docs.sh

@@ -2,24 +2,39 @@
 
 cat  ../configs/localization/*/*.md > localization_models.md
 cat  ../configs/recognition/*/*.md > recognition_models.md
+
+cat  ./tutorials/finetune.md ./tutorials/new_dataset.md ./tutorials/data_pipeline.md ./tutorials/new_modules.md > tutorials.md
+
 cat  ../tools/data/*/*.md > prepare_data.md
-sed -i 's/#/#&/' localization_models.md
-sed -i 's/#/#&/' recognition_models.md
-sed -i 's/#/#&/' prepare_data.md
-sed -i '1i\# Action Localization Models' localization_models.md
-sed -i '1i\# Action Recognition Models' recognition_models.md
-sed -i '1i\# Preparing Data' prepare_data.md
+cat  ../tools/data/*/*.md > prepare_data.md
+
+sed -i 's/#/##&/' localization_models.md
+sed -i 's/#/##&/' recognition_models.md
+
+sed -i 's/#/#&/' tutorials.md
+
+sed 's/# Preparing/# /' prepare_data.md
+sed -i 's/#/##&/' prepare_data.md
+
+sed -i '1i\# Tutorials' tutorials.md
+
+sed -i '1i\## Action Localization Models' localization_models.md
+sed -i '1i\## Action Recognition Models' recognition_models.md
+
+sed -i '1i\## Preparing Datasets' prepare_data.md
+LINE_NUMBER_MATCHING=$(sed -n '/## Inference with Pre-Trained Models/=' getting_started.md) && sed -i "$((${LINE_NUMBER_MATCHING} - 1)) r prepare_data.md" getting_started.md
+
 sed -i 's=](/=](http://gitlab.sz.sensetime.com/open-mmlab/mmaction-lite/tree/master/=g' recognition_models.md
 sed -i 's=](/=](http://gitlab.sz.sensetime.com/open-mmlab/mmaction-lite/tree/master/=g' localization_models.md
-cat index.rst | grep -q "recognition_models.md"
-if [ $? -ne 0 ] ;then
-    sed -i '/api.rst/i\   recognition_models.md' index.rst
-fi
-cat index.rst | grep -q "localization_models.md"
+cat localization_models.md recognition_models.md > modelzoo.md
+sed -i '1i\# Modelzoo' modelzoo.md
+
+cat index.rst | grep -q "modelzoo.md"
 if [ $? -ne 0 ] ;then
-    sed -i '/api.rst/i\   localization_models.md' index.rst
+    sed -i '/api.rst/i\   modelzoo.md' index.rst
 fi
-cat index.rst | grep -q "prepare_data.md"
+
+cat index.rst | grep -q "tutorials.md"
 if [ $? -ne 0 ] ;then
-    sed -i '/api.rst/i\   prepare_data.md' index.rst
+    sed -i '/api.rst/i\   tutorials.md' index.rst
 fi