Skip to content

GitLab

Unverified Commit 5111eda8 authored by Xiangxu-0103's avatar Xiangxu-0103 Committed by GitHub
Browse files

Improve the documentation of model_deployment (#1436) 

* Update model_deployment.md

* Update model_deployment.md

* update model_deployment
parent ff159fe7
Show whitespace changes
Inline Side-by-side
Showing with 72 additions and 83 deletions
docs/en/tutorials/model_deployment.md
View file @ 5111eda8
# Tutorial 7: MMDetection3D model deployment # Tutorial 8: MMDetection3D model deployment
To meet the speed requirement of the model in practical use, usually, we deploy the trained model to inference backends. [MMDeploy](https://github.com/open-mmlab/mmdeploy) is OpenMMLab model deployment framework. Now MMDeploy has supported MMDetection3D model deployment, and you can deploy the trained model to inference backends by MMDeploy. To meet the speed requirement of the model in practical use, usually, we deploy the trained model to inference backends. [MMDeploy](https://github.com/open-mmlab/mmdeploy) is OpenMMLab model deployment framework. Now MMDeploy has supported MMDetection3D model deployment, and you can deploy the trained model to inference backends by MMDeploy.
...@@ -52,17 +52,15 @@ python ./tools/deploy.py \ ...@@ -52,17 +52,15 @@ python ./tools/deploy.py \
### Example ### Example
```bash ```bash
cd mmdeploy \ cd mmdeploy
python tools/deploy.py \ python tools/deploy.py \
configs/mmdet3d/voxel-detection/voxel-detection_tensorrt_dynamic-kitti.py \ configs/mmdet3d/voxel-detection/voxel-detection_tensorrt_dynamic-kitti.py \
${$MMDET3D_DIR}/configs/pointpillars/hv_pointpillars_secfpn_6x8_160e_kitti-3d-3class.py \ ${$MMDET3D_DIR}/configs/pointpillars/hv_pointpillars_secfpn_6x8_160e_kitti-3d-3class.py \
${$MMDET3D_DIR}/checkpoints/hv_pointpillars_secfpn_6x8_160e_kitti-3d-3class_20200620_230421-aa0f3adb.pth \ ${$MMDET3D_DIR}/checkpoints/hv_pointpillars_secfpn_6x8_160e_kitti-3d-3class_20200620_230421-aa0f3adb.pth \
${$MMDET3D_DIR}/demo/data/kitti/kitti_000008.bin \ ${$MMDET3D_DIR}/demo/data/kitti/kitti_000008.bin \
--work-dir --work-dir work-dir \
work-dir \ --device cuda:0 \
--device --show
cuda:0 \
--show
``` ```
## Inference Model ## Inference Model
...@@ -83,34 +81,31 @@ You can test the accuracy and speed of the model in the inference backend. You c ...@@ -83,34 +81,31 @@ You can test the accuracy and speed of the model in the inference backend. You c
```bash ```bash
python tools/test.py \ python tools/test.py \
${DEPLOY_CFG} \ ${DEPLOY_CFG} \
${MODEL_CFG} \ ${MODEL_CFG} \
--model ${BACKEND_MODEL_FILES} \ --model ${BACKEND_MODEL_FILES} \
[--out ${OUTPUT_PKL_FILE}] \ [--out ${OUTPUT_PKL_FILE}] \
[--format-only] \ [--format-only] \
[--metrics ${METRICS}] \ [--metrics ${METRICS}] \
[--show] \ [--show] \
[--show-dir ${OUTPUT_IMAGE_DIR}] \ [--show-dir ${OUTPUT_IMAGE_DIR}] \
[--show-score-thr ${SHOW_SCORE_THR}] \ [--show-score-thr ${SHOW_SCORE_THR}] \
--device ${DEVICE} \ --device ${DEVICE} \
[--cfg-options ${CFG_OPTIONS}] \ [--cfg-options ${CFG_OPTIONS}] \
[--metric-options ${METRIC_OPTIONS}] [--metric-options ${METRIC_OPTIONS}] \
[--log2file work_dirs/output.txt] [--log2file work_dirs/output.txt]
``` ```
### Example ### Example
```bash ```bash
cd mmdeploy \ cd mmdeploy
python tools/test.py \ python tools/test.py \
configs/mmdet3d/voxel-detection/voxel-detection_onnxruntime_dynamic.py \ configs/mmdet3d/voxel-detection/voxel-detection_onnxruntime_dynamic.py \
${MMDET3D_DIR}/configs/centerpoint/centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus.py \ ${MMDET3D_DIR}/configs/centerpoint/centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus.py \
--model --model work-dir/end2end.onnx \
work-dir/end2end.onnx \ --metrics bbox \
--metrics --device cpu
bbox \
--device
cpu
``` ```
## Supported models ## Supported models
......
docs/zh_cn/tutorials/model_deployment.md
View file @ 5111eda8
# 教程 7: MMDet3D模型部署 # 教程 8: MMDet3D 模型部署
为了满足在实际使用过程中遇到的算法模型的速度需求，通常我们会将训练好的模型部署到各种推理后端上。 [MMDeploy](https://github.com/open-mmlab/mmdeploy) 是 OpenMMLab 系列算法库的部署框架，现在 MMDeploy 已经支持了MMDetection3D，我们可以通过 MMDeploy 将训练好的模型部署到各种推理后端上。 为了满足在实际使用过程中遇到的算法模型的速度需求，通常我们会将训练好的模型部署到各种推理后端上。 [MMDeploy](https://github.com/open-mmlab/mmdeploy) 是 OpenMMLab 系列算法库的部署框架，现在 MMDeploy 已经支持了 MMDetection3D，我们可以通过 MMDeploy 将训练好的模型部署到各种推理后端上。
## 准备 ## 准备
### 安装MMDeploy ### 安装 MMDeploy
```bash ```bash
git clone -b master git@github.com:open-mmlab/mmdeploy.git git clone -b master git@github.com:open-mmlab/mmdeploy.git
...@@ -14,7 +14,7 @@ git submodule update --init --recursive ...@@ -14,7 +14,7 @@ git submodule update --init --recursive
### 安装推理后端编译自定义算子 ### 安装推理后端编译自定义算子
根据 MMDeploy 的文档选择安装推理后端并编译自定义算子，目前 MMDet3D 模型支持了的推理后端有 [OnnxRuntime](https://mmdeploy.readthedocs.io/en/latest/backends/onnxruntime.html), [TensorRT](https://mmdeploy.readthedocs.io/en/latest/backends/tensorrt.html), [OpenVINO](https://mmdeploy.readthedocs.io/en/latest/backends/openvino.html) 。 根据 MMDeploy 的文档选择安装推理后端并编译自定义算子，目前 MMDet3D 模型支持了的推理后端有 [OnnxRuntime](https://mmdeploy.readthedocs.io/en/latest/backends/onnxruntime.html)，[TensorRT](https://mmdeploy.readthedocs.io/en/latest/backends/tensorrt.html)，[OpenVINO](https://mmdeploy.readthedocs.io/en/latest/backends/openvino.html)。
## 模型导出 ## 模型导出
...@@ -37,38 +37,35 @@ python ./tools/deploy.py \ ...@@ -37,38 +37,35 @@ python ./tools/deploy.py \
### 参数描述 ### 参数描述
* deploy_cfg : MMDeploy 中用于部署的配置文件路径。 * `deploy_cfg` : MMDeploy 代码库中用于部署的配置文件路径。
* model_cfg : OpenMMLab 系列代码库中使用的模型配置文件路径。 * `model_cfg` : OpenMMLab 系列代码库中使用的模型配置文件路径。
* checkpoint : OpenMMLab 系列代码库的模型文件路径。 * `checkpoint` : OpenMMLab 系列代码库的模型文件路径。
* img : 用于模型转换时使用的点云文件或图像文件路径。 * `img` : 用于模型转换时使用的点云文件或图像文件路径。
* --test-img : 用于测试模型的图像文件路径。默认设置成None。 * `--test-img` : 用于测试模型的图像文件路径。如果没有指定，将设置成 `None`。
* --work-dir : 工作目录，用来保存日志和模型文件。 * `--work-dir` : 工作目录，用来保存日志和模型文件。
* --calib-dataset-cfg : 此参数只有int8模式下生效，用于校准 * `--calib-dataset-cfg` : 此参数只在 int8 模式下生效，用于校准数据集配置文件。如果没有指定，将被设置成 `None`，并使用模型配置文件中的 'val' 数据集进行校准。
* 数据集配置文件。若在int8模式下未传入参数，则会自动使用模型配置文件中的'val'数据集进行校准。 * `--device` : 用于模型转换的设备。如果没有指定，将被设置成 cpu。
* --device : 用于模型转换的设备。 默认是cpu。 * `--log-level` : 设置日记的等级，选项包括 `'CRITICAL'，'FATAL'，'ERROR'，'WARN'，'WARNING'，'INFO'，'DEBUG'，'NOTSET'`。如果没有指定，将被设置成 INFO。
* --log-level : 设置日记的等级，选项包括'CRITICAL'， 'FATAL'， 'ERROR'， 'WARN'， 'WARNING'， 'INFO'， 'DEBUG'， 'NOTSET'。 默认是INFO。 * `--show` : 是否显示检测的结果。
* --show : 是否显示检测的结果。 * `--dump-info` : 是否输出 SDK 信息。
* --dump-info : 是否输出 SDK 信息。
### 示例 ### 示例
```bash ```bash
cd mmdeploy \ cd mmdeploy
python tools/deploy.py \ python tools/deploy.py \
configs/mmdet3d/voxel-detection/voxel-detection_tensorrt_dynamic-kitti.py \ configs/mmdet3d/voxel-detection/voxel-detection_tensorrt_dynamic-kitti.py \
${$MMDET3D_DIR}/configs/pointpillars/hv_pointpillars_secfpn_6x8_160e_kitti-3d-3class.py \ ${$MMDET3D_DIR}/configs/pointpillars/hv_pointpillars_secfpn_6x8_160e_kitti-3d-3class.py \
${$MMDET3D_DIR}/checkpoints/hv_pointpillars_secfpn_6x8_160e_kitti-3d-3class_20200620_230421-aa0f3adb.pth \ ${$MMDET3D_DIR}/checkpoints/hv_pointpillars_secfpn_6x8_160e_kitti-3d-3class_20200620_230421-aa0f3adb.pth \
${$MMDET3D_DIR}/demo/data/kitti/kitti_000008.bin \ ${$MMDET3D_DIR}/demo/data/kitti/kitti_000008.bin \
--work-dir --work-dir work-dir \
work-dir \ --device cuda:0 \
--device --show
cuda:0 \
--show
``` ```
## 模型推理 ## 模型推理
现在你可以使用推理后端提供的 API 进行模型推理。但是，如果你想立即测试模型怎么办？ 我们为您准备了一些推理后端的封装。 现在你可以使用推理后端提供的 API 进行模型推理。但是，如果你想立即测试模型怎么办？我们为您准备了一些推理后端的封装。
```python ```python
from mmdeploy.apis import inference_model from mmdeploy.apis import inference_model
...@@ -78,40 +75,37 @@ result = inference_model(model_cfg, deploy_cfg, backend_files, img=img, device=d ...@@ -78,40 +75,37 @@ result = inference_model(model_cfg, deploy_cfg, backend_files, img=img, device=d
`inference_model` 将创建一个推理后端的模块并为你进行推理。推理结果与模型的 OpenMMLab 代码库具有相同的格式。 `inference_model` 将创建一个推理后端的模块并为你进行推理。推理结果与模型的 OpenMMLab 代码库具有相同的格式。
## 测试模型 (可选) ## 测试模型（可选）
可以测试部署在推理后端上的模型的精度和速度。你可以参考 [how to measure performance of models](https://mmdeploy.readthedocs.io/en/latest/tutorials/how_to_measure_performance_of_models.html)。 可以测试部署在推理后端上的模型的精度和速度。你可以参考 [how to measure performance of models](https://mmdeploy.readthedocs.io/en/latest/tutorials/how_to_measure_performance_of_models.html)。
```bash ```bash
python tools/test.py \ python tools/test.py \
${DEPLOY_CFG} \ ${DEPLOY_CFG} \
${MODEL_CFG} \ ${MODEL_CFG} \
--model ${BACKEND_MODEL_FILES} \ --model ${BACKEND_MODEL_FILES} \
[--out ${OUTPUT_PKL_FILE}] \ [--out ${OUTPUT_PKL_FILE}] \
[--format-only] \ [--format-only] \
[--metrics ${METRICS}] \ [--metrics ${METRICS}] \
[--show] \ [--show] \
[--show-dir ${OUTPUT_IMAGE_DIR}] \ [--show-dir ${OUTPUT_IMAGE_DIR}] \
[--show-score-thr ${SHOW_SCORE_THR}] \ [--show-score-thr ${SHOW_SCORE_THR}] \
--device ${DEVICE} \ --device ${DEVICE} \
[--cfg-options ${CFG_OPTIONS}] \ [--cfg-options ${CFG_OPTIONS}] \
[--metric-options ${METRIC_OPTIONS}] [--metric-options ${METRIC_OPTIONS}] \
[--log2file work_dirs/output.txt] [--log2file work_dirs/output.txt]
``` ```
### 示例 ### 示例
```bash ```bash
cd mmdeploy \ cd mmdeploy
python tools/test.py \ python tools/test.py \
configs/mmdet3d/voxel-detection/voxel-detection_onnxruntime_dynamic.py \ configs/mmdet3d/voxel-detection/voxel-detection_onnxruntime_dynamic.py \
${MMDET3D_DIR}/configs/centerpoint/centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus.py \ ${MMDET3D_DIR}/configs/centerpoint/centerpoint_02pillar_second_secfpn_circlenms_4x8_cyclic_20e_nus.py \
--model --model work-dir/end2end.onnx \
work-dir/end2end.onnx \ --metrics bbox \
--metrics --device cpu
bbox \
--device
cpu
``` ```
## 支持模型列表 ## 支持模型列表
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment