[Docs] reorganize the documents in English and update the contents based on v0.5.0 status (#531)

* checkout qq group qrcode

* update the cover image

* update build doc

* reorganize chapters

* update readme

* remove index of build on different platforms in readthedocs

* update benchmark

* update get started document in Chinese based on the prebuild package

* update get_started

* re-style benchmark

* update get_started in zh_cn

* update get_started in english

* update get_started in english

* update get_started in english

* update get_started doc

* update according to reviewer comments

* update linker ci

* fix(.github/scripts/check_doc_linker.py): skip code block

* specify PYTHONPATH

* update get_started

* update diagram

* rename some documents

* fix according to reviewer comments

Co-authored-by: tpoisonooo <[email protected]>

Author: lvhan028

.github/scripts/doc_link_checker.py

@@ -24,9 +24,18 @@ def make_parser():
 def analyze_doc(home, path):
     print('analyze {}'.format(path))
     problem_list = []
+    code_block = False
     with open(path) as f:
         lines = f.readlines()
         for line in lines:
+            line = line.strip()
+            if line.startswith('```'):
+                code_block = not code_block
+                continue
+
+            if code_block is True:
+                continue
+
             if '[' in line and ']' in line and '(' in line and ')' in line:
                 all = pattern.findall(line)
                 for item in all:

.github/workflows/check-doc-link.yml

@@ -16,3 +16,5 @@ jobs:
           python-version: '3.7'
       - run: python3 .github/scripts/doc_link_checker.py --target docs/zh_cn
       - run: python3 .github/scripts/doc_link_checker.py --target README_zh-CN.md
+      - run: python3 .github/scripts/doc_link_checker.py --target docs/en
+      - run: python3 .github/scripts/doc_link_checker.py --target README.md

README.md

@@ -23,82 +23,88 @@
 [![badge](https://github.com/open-mmlab/mmdeploy/workflows/build/badge.svg)](https://github.com/open-mmlab/mmdeploy/actions)
 [![codecov](https://codecov.io/gh/open-mmlab/mmdeploy/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdeploy)
 [![license](https://img.shields.io/github/license/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/blob/master/LICENSE)
-[![issue resolution](https://isitmaintained.com/badge/resolution/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/issues)
-[![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/issues)
+[![issue resolution](https://img.shields.io/github/issues-closed-raw/open-mmlab/mmdeploy)](https://github.com/open-mmlab/mmdeploy/issues)
+[![open issues](https://img.shields.io/github/issues-raw/open-mmlab/mmdeploy)](https://github.com/open-mmlab/mmdeploy/issues)
 
-## Introduction
 
 English | [简体中文](README_zh-CN.md)
 
-MMDeploy is an open-source deep learning model deployment toolset. It is
-a part of the [OpenMMLab](https://openmmlab.com/) project.
+## Introduction
+
+MMDeploy is an open-source deep learning model deployment toolset. It is a part of the [OpenMMLab](https://openmmlab.com/) project.
 
 <div align="center">
-  <img src="resources/introduction.png" width="800"/>
+  <img src="resources/introduction.png">
 </div>
 
 
-### Major features
+## Main features
 
-- **Fully support OpenMMLab models**
+### Fully support OpenMMLab models
 
-  We provide a unified model deployment toolbox for the codebases in OpenMMLab. The supported codebases are listed as below, and more will be added in the future
-  - [x] MMClassification
-  - [x] MMDetection
-  - [x] MMSegmentation
-  - [x] MMEditing
-  - [x] MMOCR
-  - [x] MMPose
+The currently supported codebases and models are as follows, and more will be included in the future
+  - [mmcls](docs/en/04-supported-codebases/mmcls.md)
+  - [mmdet](docs/en/04-supported-codebases/mmdet.md)
+  - [mmseg](docs/en/04-supported-codebases/mmseg.md)
+  - [mmedit](docs/en/04-supported-codebases/mmedit.md)
+  - [mmocr](docs/en/04-supported-codebases/mmocr.md)
+  - [mmpose](docs/en/04-supported-codebases/mmpose.md)
+  - [mmdet3d](docs/en/04-supported-codebases/mmdet3d.md)
+  - [mmrotate](docs/en/04-supported-codebases/mmrotate.md)
 
-- **Multiple inference backends are available**
+### Multiple inference backends are available
 
-  Models can be exported and run in different backends. The following ones are supported, and more will be taken into consideration
-  - [x] ONNX Runtime
-  - [x] TensorRT
-  - [x] PPLNN
-  - [x] ncnn
-  - [x] OpenVINO
+Models can be exported and run in the following backends, and more will be compatible
 
-- **Efficient and highly scalable SDK Framework by C/C++**
+| ONNX Runtime | TensorRT | ppl.nn | ncnn | OpenVINO | LibTorch | more                                           |
+| ------------ | -------- | ------ | ---- | -------- | -------- | ---------------------------------------------- |
+| ✔️            | ✔️        | ✔️      | ✔️    | ✔️        | ✔️        | [benchmark](docs/en/03-benchmark/benchmark.md) |
 
-    All kinds of modules in SDK can be extensible, such as `Transform` for image processing, `Net` for Neural Network inference, `Module` for postprocessing and so on
 
-## License
-
-This project is released under the [Apache 2.0 license](LICENSE).
 
-## Installation
+### Efficient and scalable C/C++ SDK Framework
 
-Please refer to [build.md](https://mmdeploy.readthedocs.io/en/latest/build.html) for installation.
+All kinds of modules in the SDK can be extended, such as `Transform` for image processing, `Net` for Neural Network inference, `Module` for postprocessing and so on
 
-## Getting Started
+## Get Started
 
-Please see [getting_started.md](https://mmdeploy.readthedocs.io/en/latest/get_started.html) for the basic usage of MMDeploy. We also provide other tutorials for:
+Please read [getting_started.md](docs/en/get_started.md) for the basic usage of MMDeploy. We also provide tutoials about:
 
-- [how to convert model](https://mmdeploy.readthedocs.io/en/latest/tutorials/how_to_convert_model.html)
-- [how to write config](https://mmdeploy.readthedocs.io/en/latest/tutorials/how_to_write_config.html)
-- [how to support new models](https://mmdeploy.readthedocs.io/en/latest/tutorials/how_to_support_new_models.html)
-- [how to measure performance of models](https://mmdeploy.readthedocs.io/en/latest/tutorials/how_to_measure_performance_of_models.html)
+* [Build](docs/en/01-how-to-build/build_from_source.md)
+  * [Build from Docker](docs/en/01-how-to-build/build_from_docker.md)
+  * [Build for Linux](docs/en/01-how-to-build/linux-x86_64.md)
+  * [Build for Win10](docs/en/01-how-to-build/windows.md)
+  * [Build for Android](docs/en/01-how-to-build/android.md)
+  * [Build for Jetson](docs/en/01-how-to-build/jetsons.md)
+* User Guide
+  * [How to convert model](docs/en/02-how-to-run/convert_model.md)
+  * [How to write config](docs/en/02-how-to-run/write_config.md)
+  * [How to evaluate deployed models](docs/en/02-how-to-run/how_to_evaluate_a_model.md)
+  * [How to measure performance of deployed models](docs/en/02-how-to-run/how_to_measure_performance_of_models.md)
+* Developer Guide
+  * [How to support new models](docs/en/06-developer-guide/support_new_model.md)
+  * [How to support new backends](docs/en/06-developer-guide/support_new_backend.md)
+* [FAQ](docs/en/faq.md)
+* [Contributing](.github/CONTRIBUTING.md)
 
-Please refer to [FAQ](https://mmdeploy.readthedocs.io/en/latest/faq.html) for frequently asked questions.
+## Benchmark and Model zoo
 
-## Benchmark and model zoo
-
-Results and supported model list are available in the [benchmark](https://mmdeploy.readthedocs.io/en/latest/benchmark.html) and [model list](https://mmdeploy.readthedocs.io/en/latest/supported_models.html).
+You can find the supported models from [here](docs/en/03-benchmark/supported_models.md) and their performance in the [benchmark](docs/en/03-benchmark/benchmark.md).
 
 ## Contributing
 
-We appreciate all contributions to improve MMDeploy. Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the contributing guideline.
+We appreciate all contributions to MMDeploy. Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the contributing guideline.
 
 ## Acknowledgement
 
 We would like to sincerely thank the following teams for their contributions to [MMDeploy](https://github.com/open-mmlab/mmdeploy):
 - [OpenPPL](https://github.com/openppl-public)
 - [OpenVINO](https://github.com/openvinotoolkit/openvino)
+- [ncnn](https://github.com/Tencent/ncnn)
 
 ## Citation
 
-If you find this project useful in your research, please consider cite:
+If you find this project useful in your research, please consider citing:
 
 ```BibTeX
 @misc{=mmdeploy,
@@ -109,6 +115,10 @@ If you find this project useful in your research, please consider cite:
 }
 ```
 
+## License
+
+This project is released under the [Apache 2.0 license](LICENSE).
+
 ## Projects in OpenMMLab
 
 - [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab foundational library for computer vision.

README_zh-CN.md

@@ -23,13 +23,13 @@
 [![badge](https://github.com/open-mmlab/mmdeploy/workflows/build/badge.svg)](https://github.com/open-mmlab/mmdeploy/actions)
 [![codecov](https://codecov.io/gh/open-mmlab/mmdeploy/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdeploy)
 [![license](https://img.shields.io/github/license/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/blob/master/LICENSE)
-[![issue resolution](https://isitmaintained.com/badge/resolution/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/issues)
-[![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/issues)
-
-## 介绍
+[![issue resolution](https://img.shields.io/github/issues-closed-raw/open-mmlab/mmdeploy)](https://github.com/open-mmlab/mmdeploy/issues)
+[![open issues](https://img.shields.io/github/issues-raw/open-mmlab/mmdeploy)](https://github.com/open-mmlab/mmdeploy/issues)
 
 [English](README.md) | 简体中文
 
+## 介绍
+
 MMDeploy 是 [OpenMMLab](https://openmmlab.com/) 模型部署工具箱，**为各算法库提供统一的部署体验**。基于 MMDeploy，开发者可以轻松从训练 repo 生成指定硬件所需 SDK，省去大量适配时间。
 
 ## 架构简析
@@ -41,37 +41,33 @@ MMDeploy 是 [OpenMMLab](https://openmmlab.com/) 模型部署工具箱，**为
 ## 特性简介
 
 ### 支持超多 OpenMMLab 算法库
-- mmcls
-- mmdet
-- mmdet3d
-- mmedit
-- mmocr
-- mmpose
-- mmseg
-- [支持列表](docs/zh_cn/03-benchmark/supported_models.md)
+- [mmcls](docs/en/04-supported-codebases/mmcls.md)
+- [mmdet](docs/en/04-supported-codebases/mmdet.md)
+- [mmseg](docs/en/04-supported-codebases/mmseg.md)
+- [mmedit](docs/en/04-supported-codebases/mmedit.md)
+- [mmocr](docs/en/04-supported-codebases/mmocr.md)
+- [mmpose](docs/en/04-supported-codebases/mmpose.md)
+- [mmdet3d](docs/en/04-supported-codebases/mmdet3d.md)
+- [mmrotate](docs/en/04-supported-codebases/mmrotate.md)
 
 ### 支持多种推理后端
-|ONNX Runtime|TensorRT|ppl.nn|ncnn|OpenVINO|more|
-|------------|--------|------|----|--------|----|
-|✔️         |✔️      |✔️   |✔️  |✔️     |[benchmark](docs/zh_cn/03-benchmark/benchmark.md)|
+| ONNX Runtime | TensorRT | ppl.nn | ncnn | OpenVINO | more                                              |
+| ------------ | -------- | ------ | ---- | -------- | ------------------------------------------------- |
+| ✔️            | ✔️        | ✔️      | ✔️    | ✔️        | [benchmark](docs/zh_cn/03-benchmark/benchmark.md) |
 
 ### SDK 可高度定制化
 - Transform 数据预处理
 - Net 推理
 - Module 后处理
 
-## 开源许可证
-
-该项目采用 [Apache 2.0 开源许可证](LICENSE)。
-
 ## [快速上手](docs/zh_cn/get_started.md)
 
 * [编译](docs/zh_cn/01-how-to-build/build_from_source.md)
-  * [Build for Android](docs/zh_cn/01-how-to-build/android.md)
+  * [Build from Docker](docs/zh_cn/01-how-to-build/build_from_docker.md)
   * [Build for Linux](docs/zh_cn/01-how-to-build/linux-x86_64.md)
   * [Build for Win10](docs/zh_cn/01-how-to-build/windows.md)
-  * [Build for Jetson](docs/en/tutorials/how_to_install_mmdeploy_on_jetsons.md)
-  * [Build from Docker](docs/zh_cn/01-how-to-build/build_from_docker.md)
+  * [Build for Android](docs/zh_cn/01-how-to-build/android.md)
+  * [Build for Jetson](docs/en/01-how-to-build/jetsons.md)
 * 使用
   * [把模型转换到推理 Backend](docs/zh_cn/02-how-to-run/convert_model.md)
   * [配置转换参数](docs/zh_cn/02-how-to-run/write_config.md)
@@ -114,6 +110,10 @@ MMDeploy 是 [OpenMMLab](https://openmmlab.com/) 模型部署工具箱，**为
 }
 ```
 
+## 开源许可证
+
+该项目采用 [Apache 2.0 开源许可证](LICENSE)。
+
 ## OpenMMLab 的其他项目
 
 - [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab 计算机视觉基础库
@@ -138,11 +138,12 @@ MMDeploy 是 [OpenMMLab](https://openmmlab.com/) 模型部署工具箱，**为
 
 ## 欢迎加入 OpenMMLab 社区
 
-扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab)，加入 OpenMMLab 团队的 [官方交流 QQ 群](https://jq.qq.com/?_wv=1027&k=aCvMxdr3)
+扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab)，加入 OpenMMLab 团队的 [官方交流 QQ 群](https://jq.qq.com/?_wv=1027&k=MSMAfWOe)，或添加微信小助手”OpenMMLabwx“加入官方交流微信群。
 
 <div align="center">
   <img src="https://raw.githubusercontent.com/open-mmlab/mmcv/master/docs/en/_static/zhihu_qrcode.jpg" height="400" />
-  <img src="https://raw.githubusercontent.com/open-mmlab/mmcv/master/docs/en/_static/qq_group_qrcode.jpg" height="400" />
+  <img src="resources/qq_group_qrcode.jpg" height="400" />
+  <img src="https://raw.githubusercontent.com/open-mmlab/mmcv/master/docs/en/_static/wechat_qrcode.jpg" height="400" />
 </div>
 
 我们会在 OpenMMLab 社区为大家

docs/en/build/android.md docs/en/01-how-to-build/android.mddocs/en/build/android.md renamed to docs/en/01-how-to-build/android.md

@@ -17,7 +17,7 @@ Model converter is executed on linux platform, and SDK is executed on android pl
 
 Here are two steps for android build.
 
-1. Build model converter on linux, please refer to [How to build linux](./linux.md)
+1. Build model converter on linux, please refer to [How to build linux](./linux-x86_64.md)
 
 2. Build SDK using android toolchain on linux.
 

docs/en/tutorials/how_to_use_docker.md …/en/01-how-to-build/build_from_docker.mddocs/en/tutorials/how_to_use_docker.md renamed to docs/en/01-how-to-build/build_from_docker.md docs/en/tutorials/how_to_use_docker.md renamed to docs/en/01-how-to-build/build_from_docker.md

@@ -1,4 +1,4 @@
-## Docker usage
+## Use Docker Image
 
 We provide two dockerfiles for CPU and GPU respectively. For CPU users, we install MMDeploy with ONNXRuntime, ncnn and OpenVINO backends. For GPU users, we install MMDeploy with TensorRT backend. Besides, users can install mmdeploy with different versions when building the docker image.
 

docs/en/build.md …/en/01-how-to-build/build_from_source.mddocs/en/build.md renamed to docs/en/01-how-to-build/build_from_source.md docs/en/build.md renamed to docs/en/01-how-to-build/build_from_source.md

@@ -1,19 +1,19 @@
-# Build MMDeploy
+# Build From Source
 
-## Download MMDeploy
 
+## Download
 
-  ```bash
-  git clone -b master [email protected]:open-mmlab/mmdeploy.git MMDeploy
-  cd MMDeploy
-  git submodule update --init --recursive
+
+  ```shell
+  git clone -b master [email protected]:open-mmlab/mmdeploy.git --recursive
   ```
 
 Note:
 
   - If fetching submodule fails, you could get submodule manually by following instructions:
 
-      ```bash
+      ```shell
+      cd mmdeploy
       git clone [email protected]:NVIDIA/cub.git third_party/cub
       cd third_party/cub
       git checkout c3cceac115
@@ -26,15 +26,13 @@ Note:
       ```
   - If it fails when `git clone` via `SSH`, you can try the `HTTPS` protocol like this:
 
-    ```bash
-    git clone -b master https://github.com/open-mmlab/mmdeploy.git MMDeploy
-    cd MMDeploy
-    git submodule update --init --recursive
+    ```shell
+    git clone -b master https://github.com/open-mmlab/mmdeploy.git --recursive
     ```
 
-## Build MMDeploy
+## Build
 Please visit the following links to find out how to build MMDeploy according to the target platform.
-- [Linux-x86_64](build/linux.md)
-- [Windows](build/windows.md)
-- [Android-aarch64](build/android.md)
-- [NVIDIA Jetson](tutorials/how_to_install_mmdeploy_on_jetsons.md)
+- [Linux-x86_64](linux-x86_64.md)
+- [Windows](windows.md)
+- [Android-aarch64](android.md)
+- [NVIDIA Jetson](jetsons.md)

…ls/how_to_install_mmdeploy_on_jetsons.md docs/en/01-how-to-build/jetsons.mddocs/en/tutorials/how_to_install_mmdeploy_on_jetsons.md renamed to docs/en/01-how-to-build/jetsons.md docs/en/tutorials/how_to_install_mmdeploy_on_jetsons.md renamed to docs/en/01-how-to-build/jetsons.md

@@ -1,4 +1,4 @@
-## How to install mmdeploy on Jetsons
+## Build for Jetson
 
 This tutorial introduces how to install mmdeploy on Nvidia Jetson systems. It mainly introduces the installation of mmdeploy on three Jetson series boards:
 - Jetson Nano
@@ -102,7 +102,7 @@ cmake --version
 ```
 
 ### Install mmdeploy
-Just follow the instruction [here](../build.md). If it throws `failed building wheel for numpy...ERROR: Failed to build one or more wheels` when installing `h5py`, try install `h5py` manually.
+Just follow the instruction [here](../01-how-to-build/build_from_source.md). If it throws `failed building wheel for numpy...ERROR: Failed to build one or more wheels` when installing `h5py`, try install `h5py` manually.
 ```
 sudo apt-get install pkg-config libhdf5-100 libhdf5-dev
 pip install versioned-hdf5 --no-cache-dir