mirror of https://github.com/open-mmlab/mmyolo.git
[DOC] Add deploy guide doc (#220)
* Add deploy doc-0 * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Update 部署必备指南.md Co-authored-by: HinGwenWoong <peterhuang0323@qq.com> * Del unused line * Add docs * Fix * Fix * Rename docs * Rename docs Co-authored-by: HinGwenWoong <peterhuang0323@qq.com>pull/249/head
tripleMu
Haian Huang(深度眸)
parent
188377c62b
commit
47939e99da
|
|
@ -0,0 +1,312 @@
|
|||
# MMDeploy 介绍
|
||||
|
||||
MMDeploy 是 [OpenMMLab](https://openmmlab.com/) 模型部署工具箱，**为各算法库提供统一的部署体验**。基于 MMDeploy，开发者可以轻松从训练 repo 生成指定硬件所需 SDK，省去大量适配时间。
|
||||
|
||||
更多介绍和使用指南见 https://github.com/open-mmlab/mmdeploy/blob/dev-1.x/docs/zh_cn/get_started.md
|
||||
|
||||
# 算法支持列表
|
||||
|
||||
目前支持的 model-backend 组合：
|
||||
|
||||
| Model | Task | OnnxRuntime | TensorRT | Model config |
|
||||
| :----- | :-------------- | :---------: | :------: | :---------------------------------------------------------------------: |
|
||||
| YOLOv5 | ObjectDetection | Y | Y | [config](https://github.com/open-mmlab/mmyolo/tree/main/configs/yolov5) |
|
||||
| YOLOv6 | ObjectDetection | Y | Y | [config](https://github.com/open-mmlab/mmyolo/tree/main/configs/yolov6) |
|
||||
| YOLOX | ObjectDetection | Y | Y | [config](https://github.com/open-mmlab/mmyolo/tree/main/configs/yolox) |
|
||||
| RTMDet | ObjectDetection | Y | Y | [config](https://github.com/open-mmlab/mmyolo/tree/main/configs/rtmdet) |
|
||||
|
||||
ncnn 和其他后端的支持会在后续支持。
|
||||
|
||||
# MMYOLO 中部署相关配置说明
|
||||
|
||||
所有部署配置文件在 [`configs/deploy`](configs/deploy) 目录下。
|
||||
|
||||
您可以部署静态输入或者动态输入的模型，因此您需要修改模型配置文件中与此相关的数据处理流程。
|
||||
|
||||
MMDeploy 将后处理整合到自定义的算子中，因此您可以修改 `codebase_config` 中的 `post_processing` 参数来调整后处理策略，参数描述如下：
|
||||
|
||||
```python
|
||||
codebase_config = dict(
|
||||
type='mmyolo',
|
||||
task='ObjectDetection',
|
||||
model_type='end2end',
|
||||
post_processing=dict(
|
||||
score_threshold=0.05,
|
||||
confidence_threshold=0.005,
|
||||
iou_threshold=0.5,
|
||||
max_output_boxes_per_class=200,
|
||||
pre_top_k=5000,
|
||||
keep_top_k=100,
|
||||
background_label_id=-1),
|
||||
module=['mmyolo.deploy'])
|
||||
```
|
||||
|
||||
- `score_threshold`：在 `nms` 之前筛选候选框的类别分数阈值。
|
||||
- `confidence_threshold`：在 `nms` 之前筛选候选框的置信度分数阈值。
|
||||
- `iou_threshold`：在 `nms` 中去除重复框的 `iou` 阈值。
|
||||
- `max_output_boxes_per_class`：每个类别最大的输出框数量。
|
||||
- `pre_top_k`：在 `nms` 之前对候选框分数排序然后固定候选框的个数。
|
||||
- `keep_top_k`：`nms` 算法最终输出的候选框个数。
|
||||
- `background_label_id`：MMYOLO 算法中没有背景类别信息，置为 `-1` 即可。
|
||||
|
||||
### 静态输入配置
|
||||
|
||||
#### (1) 模型配置文件介绍
|
||||
|
||||
以 MMYOLO 中的 `YOLOv5` 模型配置为例，下面是对部署时使用的模型配置文件参数说明介绍。
|
||||
|
||||
```python
|
||||
_base_ = '../../yolov5/yolov5_s-v61_syncbn_8xb16-300e_coco.py'
|
||||
|
||||
test_pipeline = [
|
||||
dict(type='LoadImageFromFile', file_client_args=_base_.file_client_args),
|
||||
dict(
|
||||
type='LetterResize',
|
||||
scale=_base_.img_scale,
|
||||
allow_scale_up=False,
|
||||
use_mini_pad=False,
|
||||
),
|
||||
dict(type='LoadAnnotations', with_bbox=True, _scope_='mmdet'),
|
||||
dict(
|
||||
type='mmdet.PackDetInputs',
|
||||
meta_keys=('img_id', 'img_path', 'ori_shape', 'img_shape',
|
||||
'scale_factor', 'pad_param'))
|
||||
]
|
||||
|
||||
test_dataloader = dict(
|
||||
dataset=dict(pipeline=test_pipeline, batch_shapes_cfg=None))
|
||||
```
|
||||
|
||||
`_base_ = '../../yolov5/yolov5_s-v61_syncbn_8xb16-300e_coco.py'` 继承了训练时构建模型的配置。
|
||||
|
||||
`test_pipeline` 为部署时对输入图像进行处理的流程，`LetterResize` 控制了输入图像的尺寸，同时限制了导出模型所能接受的输入尺寸。
|
||||
|
||||
`test_dataloader` 为部署时构建数据加载器配置，`batch_shapes_cfg` 控制了是否启用 `batch_shapes` 策略，详细内容可以参考 [yolov5 配置文件说明](https://github.com/open-mmlab/mmyolo/blob/main/docs/zh_cn/user_guides/config.md) 。
|
||||
|
||||
#### (2) 部署配置文件介绍
|
||||
|
||||
以 `MMYOLO` 中的 `YOLOv5` 部署配置为例，下面是对配置文件参数说明介绍。
|
||||
|
||||
`ONNXRuntime` 部署 `YOLOv5` 可以使用 [`detection_onnxruntime_static.py`](configs/deploy/detection_onnxruntime_static.py) 配置。
|
||||
|
||||
```python
|
||||
_base_ = ['./base_static.py']
|
||||
codebase_config = dict(
|
||||
type='mmyolo',
|
||||
task='ObjectDetection',
|
||||
model_type='end2end',
|
||||
post_processing=dict(
|
||||
score_threshold=0.05,
|
||||
confidence_threshold=0.005,
|
||||
iou_threshold=0.5,
|
||||
max_output_boxes_per_class=200,
|
||||
pre_top_k=5000,
|
||||
keep_top_k=100,
|
||||
background_label_id=-1),
|
||||
module=['mmyolo.deploy'])
|
||||
backend_config = dict(type='onnxruntime')
|
||||
```
|
||||
|
||||
`backend_config` 中指定了部署后端 `type=‘onnxruntime’`，其他信息可参考第三小节。
|
||||
|
||||
`TensorRT` 部署 `YOLOv5` 可以使用 [`detection_tensorrt_static-640x640.py`](config/deploy/detection_tensorrt_static-640x640.py) 配置。
|
||||
|
||||
```python
|
||||
_base_ = ['./base_static.py']
|
||||
onnx_config = dict(input_shape=(640, 640))
|
||||
backend_config = dict(
|
||||
type='tensorrt',
|
||||
common_config=dict(fp16_mode=False, max_workspace_size=1 << 30),
|
||||
model_inputs=[
|
||||
dict(
|
||||
input_shapes=dict(
|
||||
input=dict(
|
||||
min_shape=[1, 3, 640, 640],
|
||||
opt_shape=[1, 3, 640, 640],
|
||||
max_shape=[1, 3, 640, 640])))
|
||||
])
|
||||
use_efficientnms = False
|
||||
```
|
||||
|
||||
`backend_config` 中指定了后端 `type=‘tensorrt’`。
|
||||
|
||||
与 `ONNXRuntime` 部署配置不同的是，`TensorRT` 需要指定输入图片尺寸和构建引擎文件需要的参数，包括：
|
||||
|
||||
- `onnx_config` 中指定 `input_shape=(640, 640)`
|
||||
- `backend_config['common_config']` 中 `fp16_mode=False` 和 `max_workspace_size=1 << 30`, `fp16_mode` 表示是否以 `fp16` 的参数格式构建引擎，`max_workspace_size` 表示当前 `gpu` 设备最大显存, 单位为 `GB`。`fp16` 的详细配置可以参考 [`detection_tensorrt-fp16_static-640x640.py`](configs/deploy/detection_tensorrt-fp16_static-640x640.py)
|
||||
- `backend_config['model_inputs']['input_shapes']['input']` 中 `min_shape` /`opt_shape`/`max_shape` 对应的值在静态输入下应该保持相同，即默认均为 `[1, 3, 640, 640]`。
|
||||
|
||||
`use_efficientnms` 是 `MMYOLO` 系列新引入的配置，表示在导出 `onnx` 时是否启用`Efficient NMS Plugin`来替换 `MMDeploy` 中的 `TRTBatchedNMS plugin` 。
|
||||
|
||||
可以参考 `TensorRT` 官方实现的 [Efficient NMS Plugin](https://github.com/NVIDIA/TensorRT/blob/main/plugin/efficientNMSPlugin/README.md) 获取更多详细信息。
|
||||
|
||||
**注意**，这个功能仅仅在 TensorRT >= 8.0 版本才能使用，无需编译开箱即用。
|
||||
|
||||
### 动态输入配置
|
||||
|
||||
#### (1) 模型配置文件介绍
|
||||
|
||||
当您部署静态输入模型时，您无需修改任何模型配置文件，仅需要修改部署配置文件即可。
|
||||
|
||||
#### (2) 部署配置文件介绍
|
||||
|
||||
`ONNXRuntime` 部署 `YOLOv5` 可以使用 [`detection_onnxruntime_dynamic.py`](configs/deploy/detection_onnxruntime_dynamic.py) 配置。
|
||||
|
||||
```python
|
||||
_base_ = ['./base_dynamic.py']
|
||||
codebase_config = dict(
|
||||
type='mmyolo',
|
||||
task='ObjectDetection',
|
||||
model_type='end2end',
|
||||
post_processing=dict(
|
||||
score_threshold=0.05,
|
||||
confidence_threshold=0.005,
|
||||
iou_threshold=0.5,
|
||||
max_output_boxes_per_class=200,
|
||||
pre_top_k=5000,
|
||||
keep_top_k=100,
|
||||
background_label_id=-1),
|
||||
module=['mmyolo.deploy'])
|
||||
backend_config = dict(type='onnxruntime')
|
||||
```
|
||||
|
||||
`backend_config` 中指定了后端 `type='onnxruntime'`，其他配置与上一节在 ONNXRuntime 部署静态输入模型相同。
|
||||
|
||||
`TensorRT` 部署 `YOLOv5` 可以使用 [`detection_tensorrt_dynamic-192x192-960x960.py`](config/deploy/detection_tensorrt_dynamic-192x192-960x960.py) 配置。
|
||||
|
||||
```python
|
||||
_base_ = ['./base_dynamic.py']
|
||||
backend_config = dict(
|
||||
type='tensorrt',
|
||||
common_config=dict(fp16_mode=False, max_workspace_size=1 << 30),
|
||||
model_inputs=[
|
||||
dict(
|
||||
input_shapes=dict(
|
||||
input=dict(
|
||||
min_shape=[1, 3, 192, 192],
|
||||
opt_shape=[1, 3, 640, 640],
|
||||
max_shape=[1, 3, 960, 960])))
|
||||
])
|
||||
use_efficientnms = False
|
||||
```
|
||||
|
||||
`backend_config` 中指定了后端 `type='tensorrt'`，由于 `TensorRT` 动态输入与静态输入有所不同，您可以了解更多动态输入相关信息通过访问 [TensorRT dynamic input official introduction](https://docs.nvidia.com/deeplearning/tensorrt/archives/tensorrt-843/developer-guide/index.html#work_dynamic_shapes)。
|
||||
|
||||
`TensorRT` 部署需要配置 `min_shape`, `opt_shape`, `max_shape` ，`TensorRT` 限制输入图片的尺寸在 `min_shape` 和 ` max_shape` 之间。
|
||||
|
||||
`min_shape` 为输入图片的最小尺寸，`opt_shape` 为输入图片常见尺寸, 在这个尺寸下推理性能最好，`max_shape` 为输入图片的最大尺寸。
|
||||
|
||||
`use_efficientnms` 配置与上节 `TensorRT` 静态输入配置相同。
|
||||
|
||||
### INT8 量化配置
|
||||
|
||||
!!! 部署 TensorRT INT8 模型教程即将发布 !!!
|
||||
|
||||
# 模型转换
|
||||
|
||||
### 使用方法
|
||||
|
||||
设置 `MMDeploy` 根目录为环境变量 `MMDEPLOY_DIR` ，例如 `export MMDEPLOY_DIR=/the/root/path/of/MMDeploy`
|
||||
|
||||
```shell
|
||||
python3 &(MMDEPLOY_DIR)/tools/deploy.py \
|
||||
${DEPLOY_CFG_PATH} \
|
||||
${MODEL_CFG_PATH} \
|
||||
${MODEL_CHECKPOINT_PATH} \
|
||||
${INPUT_IMG} \
|
||||
--test-img ${TEST_IMG} \
|
||||
--work-dir ${WORK_DIR} \
|
||||
--calib-dataset-cfg ${CALIB_DATA_CFG} \
|
||||
--device ${DEVICE} \
|
||||
--log-level INFO \
|
||||
--show \
|
||||
--dump-info
|
||||
```
|
||||
|
||||
### 参数描述
|
||||
|
||||
- `deploy_cfg` : mmdeploy 针对此模型的部署配置，包含推理框架类型、是否量化、输入 shape 是否动态等。配置文件之间可能有引用关系，`configs/deploy/detection_onnxruntime_static.py` 是一个示例。
|
||||
- `model_cfg` : MMYOLO 算法库的模型配置，例如 `configs/deploy/model/yolov5_s-deploy.py`, 与 mmdeploy 的路径无关.
|
||||
- `checkpoint` : torch 模型路径。可以 http/https 开头，详见 `mmcv.FileClient` 的实现。.
|
||||
- `img` : 模型转换时，用做测试的图像文件路径。
|
||||
- `--test-img` : 用于测试模型的图像文件路径。默认设置成`None`。
|
||||
- `--work-dir` : 工作目录，用来保存日志和模型文件。
|
||||
- `--calib-dataset-cfg` : 此参数只有int8模式下生效，用于校准数据集配置文件。若在int8模式下未传入参数，则会自动使用模型配置文件中的'val'数据集进行校准。
|
||||
- `--device` : 用于模型转换的设备。 默认是`cpu`，对于 trt 可使用 `cuda:0` 这种形式。
|
||||
- `--log-level` : 设置日记的等级，选项包括`'CRITICAL'， 'FATAL'， 'ERROR'， 'WARN'， 'WARNING'， 'INFO'， 'DEBUG'， 'NOTSET'`。 默认是`INFO`。
|
||||
- `--show` : 是否显示检测的结果。
|
||||
- `--dump-info` : 是否输出 SDK 信息。
|
||||
|
||||
# 模型评测
|
||||
|
||||
当您将 PyTorch 模型转换为后端支持的模型后，您可能需要验证模型的精度，使用 `&(MMDEPLOY_DIR)/tools/test.py`
|
||||
|
||||
```shell
|
||||
python3 &(MMDEPLOY_DIR)/tools/test.py \
|
||||
${DEPLOY_CFG} \
|
||||
${MODEL_CFG} \
|
||||
--model ${BACKEND_MODEL_FILES} \
|
||||
[--out ${OUTPUT_PKL_FILE}] \
|
||||
[--format-only] \
|
||||
[--metrics ${METRICS}] \
|
||||
[--show] \
|
||||
[--show-dir ${OUTPUT_IMAGE_DIR}] \
|
||||
[--show-score-thr ${SHOW_SCORE_THR}] \
|
||||
--device ${DEVICE} \
|
||||
[--cfg-options ${CFG_OPTIONS}] \
|
||||
[--metric-options ${METRIC_OPTIONS}]
|
||||
[--log2file work_dirs/output.txt]
|
||||
[--batch-size ${BATCH_SIZE}]
|
||||
[--speed-test] \
|
||||
[--warmup ${WARM_UP}] \
|
||||
[--log-interval ${LOG_INTERVERL}]
|
||||
```
|
||||
|
||||
## 参数描述
|
||||
|
||||
- `deploy_cfg`: 部署配置文件。
|
||||
- `model_cfg`: MMYOLO 模型配置文件。
|
||||
- `--model`: 导出的后端模型。 例如, 如果我们导出了 TensorRT 模型，我们需要传入后缀为 ".engine" 文件路径。
|
||||
- `--out`: 保存 pickle 格式的输出结果，仅当您传入这个参数时启用。
|
||||
- `--format-only`: 是否格式化输出结果而不进行评估。当您要将结果格式化为特定格式并将其提交到测试服务器时，它很有用。
|
||||
- `--metrics`: 用于评估 MMYOLO 中定义的模型的指标，如 COCO 标注格式的 "proposal" 。
|
||||
- `--show`: 是否在屏幕上显示评估结果。
|
||||
- `--show-dir`: 保存评估结果的目录。(只有给出这个参数才会保存结果)。
|
||||
- `--show-score-thr`: 确定是否显示检测边界框的阈值。
|
||||
- `--device`: 运行模型的设备。请注意，某些后端会限制设备。例如，TensorRT 必须在 cuda 上运行。
|
||||
- `--cfg-options`: 传入额外的配置，将会覆盖当前部署配置。
|
||||
- `--metric-options`: 用于评估的自定义选项。 xxx=yyy 中的键值对格式，将是 dataset.evaluate() 函数的 kwargs。
|
||||
- `--log2file`: 将评估结果（和速度）记录到文件中。
|
||||
- `--batch-size`: 推理的批量大小，它将覆盖数据配置中的 `samples_per_gpu`。默认为 `1`。请注意，并非所有模型都支持 `batch_size > 1`。
|
||||
- `--speed-test`: 是否开启速度测试。
|
||||
- `--warmup`: 在计算推理时间之前进行预热，需要先开启 `speed-test`。
|
||||
- `--log-interval`: 每个日志之间的间隔，需要先设置 `speed-test`。
|
||||
|
||||
注意：`&(MMDEPLOY_DIR)/tools/test.py` 中的其他参数用于速度测试。他们不影响评估。
|
||||
|
||||
# 模型推理
|
||||
|
||||
当您评测部署模型精度后，您可以使用 `mmyolo/demo/image_demo_deploy.py` 来测试本地图片并选择展示或保存可视化结果。
|
||||
|
||||
```shell
|
||||
python3 demo/image_demo_deploy.py \
|
||||
${IMG} \
|
||||
${MODEL_CFG} \
|
||||
${DEPLOY_CFG} \
|
||||
${CHECKPOINT} \
|
||||
[--out-dir ${OUTPUT_DIR}] \
|
||||
[--device] ${DEVICE}\
|
||||
[--show] \
|
||||
[--score-thr ${SHOW_SCORE_THR}
|
||||
```
|
||||
|
||||
## 参数描述
|
||||
|
||||
- `img` ：待检测的图片路径，文件夹路径，或图片网址。
|
||||
- `model_cfg`: MMYOLO 模型配置文件。
|
||||
- `deploy_cfg`: 部署配置文件。
|
||||
- `CHECKPOINT`: 导出的后端模型。 例如, 如果我们导出了 TensorRT 模型，我们需要传入后缀为 ".engine" 文件路径。
|
||||
- `--out-dir`: 保存检测的可视化结果文件夹。
|
||||
- `--device`: 运行模型的设备。请注意，某些后端会限制设备。例如，TensorRT 必须在 cuda 上运行。
|
||||
- `--show`: 是否在屏幕上显示检测的可视化结果，当您开启此选项后，将会关闭保存可视化结果。
|
||||
- `--score-thr`: 确定是否显示检测边界框的阈值。
|
||||
|
|
@ -0,0 +1,321 @@
|
|||
# YOLOv5 部署全流程说明
|
||||
|
||||
请先参考 [`部署必备指南`](./部署必备指南.md) 了解部署配置文件等相关信息。
|
||||
|
||||
## 模型训练和测试
|
||||
|
||||
模型训练和测试请参考 [`YOLOv5 从入门到部署全流程`](docs/zh_cn/user_guides/yolov5_tutorial.md) 。
|
||||
|
||||
## 准备 MMDeploy 运行环境
|
||||
|
||||
安装 `MMDeploy` 请参考 [`源码手动安装`](https://github.com/open-mmlab/mmdeploy/blob/dev-1.x/docs/zh_cn/01-how-to-build/build_from_source.md) ，选择您所使用的平台编译 `MMDeploy` 和自定义算子。
|
||||
|
||||
*注意！* 如果环境安装有问题，可以查看 [`MMDeploy FAQ`](https://github.com/open-mmlab/mmdeploy/blob/dev-1.x/docs/zh_cn/faq.md) 或者在 `issuse` 中提出您的问题。
|
||||
|
||||
## 准备模型配置文件
|
||||
|
||||
本例将以基于 `coco` 数据集预训练的 `YOLOv5` 配置和权重进行部署的全流程讲解，包括静态/动态输入模型导出和推理，`TensorRT` / `ONNXRuntime` 两种后端部署和测试。
|
||||
|
||||
### 静态输入配置
|
||||
|
||||
#### (1) 模型配置文件
|
||||
|
||||
当您需要部署静态输入模型时，您应该确保模型的输入尺寸是固定的，比如在测试流程或测试数据集加载时输入尺寸为 `640x640`。
|
||||
|
||||
您可以查看 [`yolov5_s-deploy.py`](configs/deploy/model/yolov5_s-deploy.py) 中测试流程或测试数据集加载部分，如下所示：
|
||||
|
||||
```python
|
||||
_base_ = '../../yolov5/yolov5_s-v61_syncbn_8xb16-300e_coco.py'
|
||||
|
||||
test_pipeline = [
|
||||
dict(type='LoadImageFromFile', file_client_args=_base_.file_client_args),
|
||||
dict(
|
||||
type='LetterResize',
|
||||
scale=_base_.img_scale,
|
||||
allow_scale_up=False,
|
||||
use_mini_pad=False,
|
||||
),
|
||||
dict(type='LoadAnnotations', with_bbox=True, _scope_='mmdet'),
|
||||
dict(
|
||||
type='mmdet.PackDetInputs',
|
||||
meta_keys=('img_id', 'img_path', 'ori_shape', 'img_shape',
|
||||
'scale_factor', 'pad_param'))
|
||||
]
|
||||
|
||||
test_dataloader = dict(
|
||||
dataset=dict(pipeline=test_pipeline, batch_shapes_cfg=None))
|
||||
```
|
||||
|
||||
由于 `yolov5` 在测试时会开启 `allow_scale_up` 和 `use_mini_pad` 改变输入图像的尺寸来取得更高的精度，但是会给部署静态输入模型造成输入尺寸不匹配的问题。
|
||||
|
||||
该配置相比与原始配置文件进行了如下修改:
|
||||
|
||||
- 关闭 `test_pipline` 中改变尺寸相关的配置，如 `LetterResize` 中 `allow_scale_up=False` 和 `use_mini_pad=False` 。
|
||||
- 关闭 `test_dataloader` 中 `batch shapes` 策略，即 `batch_shapes_cfg=None` 。
|
||||
|
||||
#### (2) 部署配置文件
|
||||
|
||||
当您部署在 `ONNXRuntime` 时，您可以查看 [`detection_onnxruntime_static.py`](configs/deploy/detection_onnxruntime_static.py) ，如下所示：
|
||||
|
||||
```python
|
||||
_base_ = ['./base_static.py']
|
||||
codebase_config = dict(
|
||||
type='mmyolo',
|
||||
task='ObjectDetection',
|
||||
model_type='end2end',
|
||||
post_processing=dict(
|
||||
score_threshold=0.05,
|
||||
confidence_threshold=0.005,
|
||||
iou_threshold=0.5,
|
||||
max_output_boxes_per_class=200,
|
||||
pre_top_k=5000,
|
||||
keep_top_k=100,
|
||||
background_label_id=-1),
|
||||
module=['mmyolo.deploy'])
|
||||
backend_config = dict(type='onnxruntime')
|
||||
```
|
||||
|
||||
默认配置中的 `post_processing` 后处理参数是当前模型与 `pytorch` 模型精度对齐的配置，若您需要修改相关参数，可以参考 [`部署必备指南`](./部署必备指南.md) 的详细介绍。
|
||||
|
||||
当您部署在 `TensorRT` 时，您可以查看 [`detection_tensorrt_static-640x640.py`](config/deploy/detection_tensorrt_static-640x640.py) ，如下所示：
|
||||
|
||||
```python
|
||||
_base_ = ['./base_static.py']
|
||||
onnx_config = dict(input_shape=(640, 640))
|
||||
backend_config = dict(
|
||||
type='tensorrt',
|
||||
common_config=dict(fp16_mode=False, max_workspace_size=1 << 30),
|
||||
model_inputs=[
|
||||
dict(
|
||||
input_shapes=dict(
|
||||
input=dict(
|
||||
min_shape=[1, 3, 640, 640],
|
||||
opt_shape=[1, 3, 640, 640],
|
||||
max_shape=[1, 3, 640, 640])))
|
||||
])
|
||||
use_efficientnms = False
|
||||
```
|
||||
|
||||
本例使用了默认的输入尺寸 `input_shape=(640, 640)` ，构建网络以 `fp32` 模式即 `fp16_mode=False`，并且默认构建 `TensorRT` 构建引擎所使用的显存 `max_workspace_size=1 << 30` 即最大为 `1GB` 显存。
|
||||
|
||||
### 动态输入配置
|
||||
|
||||
#### (1) 模型配置文件
|
||||
|
||||
当您需要部署动态输入模型时，模型的输入可以为任意尺寸(`TensorRT` 会限制最小和最大输入尺寸)，因此使用默认的 [`yolov5_s-v61_syncbn_8xb16-300e_coco.py`](configs/yolov5/yolov5_s-v61_syncbn_8xb16-300e_coco.py) 模型配置文件即可，其中数据处理和数据集加载器部分如下所示：
|
||||
|
||||
```python
|
||||
batch_shapes_cfg = dict(
|
||||
type='BatchShapePolicy',
|
||||
batch_size=val_batch_size_per_gpu,
|
||||
img_size=img_scale[0],
|
||||
size_divisor=32,
|
||||
extra_pad_ratio=0.5)
|
||||
|
||||
test_pipeline = [
|
||||
dict(type='LoadImageFromFile', file_client_args=_base_.file_client_args),
|
||||
dict(type='YOLOv5KeepRatioResize', scale=img_scale),
|
||||
dict(
|
||||
type='LetterResize',
|
||||
scale=img_scale,
|
||||
allow_scale_up=False,
|
||||
pad_val=dict(img=114)),
|
||||
dict(type='LoadAnnotations', with_bbox=True, _scope_='mmdet'),
|
||||
dict(
|
||||
type='mmdet.PackDetInputs',
|
||||
meta_keys=('img_id', 'img_path', 'ori_shape', 'img_shape',
|
||||
'scale_factor', 'pad_param'))
|
||||
]
|
||||
|
||||
val_dataloader = dict(
|
||||
batch_size=val_batch_size_per_gpu,
|
||||
num_workers=val_num_workers,
|
||||
persistent_workers=persistent_workers,
|
||||
pin_memory=True,
|
||||
drop_last=False,
|
||||
sampler=dict(type='DefaultSampler', shuffle=False),
|
||||
dataset=dict(
|
||||
type=dataset_type,
|
||||
data_root=data_root,
|
||||
test_mode=True,
|
||||
data_prefix=dict(img='val2017/'),
|
||||
ann_file='annotations/instances_val2017.json',
|
||||
pipeline=test_pipeline,
|
||||
batch_shapes_cfg=batch_shapes_cfg))
|
||||
```
|
||||
|
||||
其中 `LetterResize` 类初始化传入了 `allow_scale_up=False` 控制输入的小图像是否上采样，同时默认 `use_mini_pad=False` 关闭了图片最小填充策略，`val_dataloader['dataset']`中传入了 `batch_shapes_cfg=batch_shapes_cfg`，即按照 `batch` 内的输入尺寸进行最小填充。上述策略会改变输入图像的尺寸，因此动态输入模型在测试时会按照上述数据集加载器动态输入。
|
||||
|
||||
#### (2) 部署配置文件
|
||||
|
||||
当您部署在 `ONNXRuntime` 时，您可以查看 [`detection_onnxruntime_dynamic.py`](configs/deploy/detection_onnxruntime_dynamic.py) ，如下所示：
|
||||
|
||||
```python
|
||||
_base_ = ['./base_dynamic.py']
|
||||
codebase_config = dict(
|
||||
type='mmyolo',
|
||||
task='ObjectDetection',
|
||||
model_type='end2end',
|
||||
post_processing=dict(
|
||||
score_threshold=0.05,
|
||||
confidence_threshold=0.005,
|
||||
iou_threshold=0.5,
|
||||
max_output_boxes_per_class=200,
|
||||
pre_top_k=5000,
|
||||
keep_top_k=100,
|
||||
background_label_id=-1),
|
||||
module=['mmyolo.deploy'])
|
||||
backend_config = dict(type='onnxruntime')
|
||||
```
|
||||
|
||||
与静态输入配置仅有 `_base_ = ['./base_dynamic.py']` 不同，动态输入会额外继承 `dynamic_axes` 属性。其他配置与静态输入配置相同。
|
||||
|
||||
当您部署在 `TensorRT` 时，您可以查看 [`detection_tensorrt_dynamic-192x192-960x960.py`](config/deploy/detection_tensorrt_dynamic-192x192-960x960.py) ，如下所示：
|
||||
|
||||
```python
|
||||
_base_ = ['./base_dynamic.py']
|
||||
backend_config = dict(
|
||||
type='tensorrt',
|
||||
common_config=dict(fp16_mode=False, max_workspace_size=1 << 30),
|
||||
model_inputs=[
|
||||
dict(
|
||||
input_shapes=dict(
|
||||
input=dict(
|
||||
min_shape=[1, 3, 192, 192],
|
||||
opt_shape=[1, 3, 640, 640],
|
||||
max_shape=[1, 3, 960, 960])))
|
||||
])
|
||||
use_efficientnms = False
|
||||
```
|
||||
|
||||
本例构建网络以 `fp32` 模式即 `fp16_mode=False`，构建 `TensorRT` 构建引擎所使用的显存 `max_workspace_size=1 << 30` 即最大为 `1GB` 显存。
|
||||
|
||||
同时默认配置 `min_shape=[1, 3, 192, 192]`，`opt_shape=[1, 3, 640, 640]` ，`max_shape=[1, 3, 960, 960]` ，意为该模型所能接受的输入尺寸最小为 `192x192` ，最大为 `960x960`，最常见尺寸为 `640x640`。
|
||||
|
||||
当您部署自己的模型时，需要根据您的输入图像尺寸进行调整。
|
||||
|
||||
## 模型转换
|
||||
|
||||
本教程所使用的 `MMDeploy` 根目录为 `/home/openmmlab/dev/mmdeploy`，请注意修改为您的 `MMDeploy` 目录。
|
||||
预训练权重下载于 [yolov5_s-v61_syncbn_fast_8xb16-300e_coco_20220918_084700-86e02187.pth](https://download.openmmlab.com/mmyolo/v0/yolov5/yolov5_s-v61_syncbn_fast_8xb16-300e_coco/yolov5_s-v61_syncbn_fast_8xb16-300e_coco_20220918_084700-86e02187.pth) ，保存在本地的 `/home/openmmlab/dev/mmdeploy/yolov5s.pth`。
|
||||
|
||||
```shell
|
||||
wget https://download.openmmlab.com/mmyolo/v0/yolov5/yolov5_s-v61_syncbn_fast_8xb16-300e_coco/yolov5_s-v61_syncbn_fast_8xb16-300e_coco_20220918_084700-86e02187.pth -O /home/openmmlab/dev/mmdeploy/yolov5s.pth
|
||||
```
|
||||
|
||||
命令行执行以下命令配置相关路径：
|
||||
|
||||
```shell
|
||||
export MMDEPLOY_DIR=/home/openmmlab/dev/mmdeploy
|
||||
export PATH_TO_CHECKPOINTS=/home/openmmlab/dev/mmdeploy/yolov5s.pth
|
||||
```
|
||||
|
||||
### YOLOv5 静态输入模型导出
|
||||
|
||||
#### ONNXRuntime
|
||||
|
||||
```shell
|
||||
python3 &(MMDEPLOY_DIR)/tools/deploy.py \
|
||||
configs/deploy/detection_onnxruntime_static.py \
|
||||
configs/deploy/model/yolov5_s-static.py \
|
||||
${PATH_TO_CHECKPOINTS} \
|
||||
demo/demo.jpg \
|
||||
--work-dir work_dir \
|
||||
--show \
|
||||
--device cpu
|
||||
```
|
||||
|
||||
#### TensorRT
|
||||
|
||||
```bash
|
||||
python3 &(MMDEPLOY_DIR)/tools/deploy.py \
|
||||
configs/deploy/detection_tensorrt_static-640x640.py \
|
||||
configs/deploy/model/yolov5_s-static.py \
|
||||
${PATH_TO_CHECKPOINTS} \
|
||||
demo/demo.jpg \
|
||||
--work-dir work_dir \
|
||||
--show \
|
||||
--device cuda:0
|
||||
```
|
||||
|
||||
### YOLOv5 动态输入模型导出
|
||||
|
||||
#### ONNXRuntime
|
||||
|
||||
```shell
|
||||
python3 &(MMDEPLOY_DIR)/tools/deploy.py \
|
||||
configs/deploy/detection_onnxruntime_dynamic.py \
|
||||
configs/yolov5/yolov5_s-v61_syncbn_8xb16-300e_coco.py \
|
||||
${PATH_TO_CHECKPOINTS} \
|
||||
demo/demo.jpg \
|
||||
--work-dir work_dir \
|
||||
--show \
|
||||
--device cpu
|
||||
```
|
||||
|
||||
#### TensorRT
|
||||
|
||||
```shell
|
||||
python3 &(MMDEPLOY_DIR)/tools/deploy.py \
|
||||
configs/deploy/detection_tensorrt_dynamic-192x192-960x960.py \
|
||||
configs/yolov5/yolov5_s-v61_syncbn_8xb16-300e_coco.py \
|
||||
${PATH_TO_CHECKPOINTS} \
|
||||
demo/demo.jpg \
|
||||
--work-dir work_dir \
|
||||
--show \
|
||||
--device cuda:0
|
||||
```
|
||||
|
||||
当您使用上述命令转换模型时，您将会在 `work_dir` 文件夹下发现以下文件：
|
||||
|
||||
|
||||
|
||||
或者
|
||||
|
||||
|
||||
|
||||
在导出 `onnxruntime`模型后，您将得到图1的三个文件，其中 `end2end.onnx` 表示导出的`onnxruntime`模型。
|
||||
|
||||
在导出 `TensorRT`模型后，您将得到图2的四个文件，其中 `end2end.onnx` 表示导出的中间模型，`MMDeploy`利用该模型自动继续转换获得 `end2end.engine` 模型用于 `TensorRT `部署。
|
||||
|
||||
## 模型评测
|
||||
|
||||
当您转换模型成功后，可以使用 `&(MMDEPLOY_DIR)/tools/test.py` 工具对转换后的模型进行评测。下面是对 `ONNXRuntime` 和 `TensorRT` 静态模型的评测，动态模型评测修改传入模型配置即可。
|
||||
|
||||
### ONNXRuntime
|
||||
|
||||
```shell
|
||||
python3 &(MMDEPLOY_DIR)/tools/test.py \
|
||||
configs/deploy/detection_onnxruntime_static.py \
|
||||
configs/deploy/model/yolov5_s-static.py \
|
||||
--model work_dir/end2end.onnx \
|
||||
--device cpu \
|
||||
--work-dir work_dir
|
||||
```
|
||||
|
||||
执行完成您将看到命令行输出检测结果指标如下：
|
||||
|
||||
|
||||
|
||||
### TensorRT
|
||||
|
||||
**注意**： TensorRT 需要执行设备是 `cuda`
|
||||
|
||||
```shell
|
||||
python3 &(MMDEPLOY_DIR)/tools/test.py \
|
||||
configs/deploy/detection_tensorrt_static-640x640.py \
|
||||
configs/deploy/model/yolov5_s-static.py \
|
||||
--model work_dir/end2end.engine \
|
||||
--device cuda:0 \
|
||||
--work-dir work_dir
|
||||
```
|
||||
|
||||
执行完成您将看到命令行输出检测结果指标如下：
|
||||
|
||||
|
||||
|
||||
**未来我们将会支持模型测速等更加实用的脚本**
|
||||
|
||||
## 模型推理
|
||||
|
||||
TODO
|
||||
Loading…
Reference in New Issue