190 lines
7.1 KiB
Markdown
190 lines
7.1 KiB
Markdown
# MMRotate 模型部署
|
||
|
||
- [MMRotate 模型部署](#mmrotate-模型部署)
|
||
- [安装](#安装)
|
||
- [安装 mmrotate](#安装-mmrotate)
|
||
- [安装 mmdeploy](#安装-mmdeploy)
|
||
- [模型转换](#模型转换)
|
||
- [模型规范](#模型规范)
|
||
- [模型推理](#模型推理)
|
||
- [后端模型推理](#后端模型推理)
|
||
- [SDK 模型推理](#sdk-模型推理)
|
||
- [模型支持列表](#模型支持列表)
|
||
|
||
______________________________________________________________________
|
||
|
||
[MMRotate](https://github.com/open-mmlab/mmrotate) 是一个基于 PyTorch 的旋转物体检测的开源工具箱，也是 [OpenMMLab](https://openmmlab.com/) 项目的一部分。
|
||
|
||
## 安装
|
||
|
||
### 安装 mmrotate
|
||
|
||
请参考[官网安装指南](https://mmrotate.readthedocs.io/zh_CN/1.x/get_started.html)。
|
||
|
||
### 安装 mmdeploy
|
||
|
||
mmdeploy 有以下几种安装方式:
|
||
|
||
**方式一：** 安装预编译包
|
||
|
||
> 待 mmdeploy 正式发布 dev-1.x，再补充
|
||
|
||
**方式二：** 一键式脚本安装
|
||
|
||
如果部署平台是 **Ubuntu 18.04 及以上版本**， 请参考[脚本安装说明](../01-how-to-build/build_from_script.md)，完成安装过程。
|
||
比如，以下命令可以安装 mmdeploy 以及配套的推理引擎——`ONNX Runtime`.
|
||
|
||
```shell
|
||
git clone --recursive -b dev-1.x https://github.com/open-mmlab/mmdeploy.git
|
||
cd mmdeploy
|
||
python3 tools/scripts/build_ubuntu_x64_ort.py $(nproc)
|
||
export PYTHONPATH=$(pwd)/build/lib:$PYTHONPATH
|
||
export LD_LIBRARY_PATH=$(pwd)/../mmdeploy-dep/onnxruntime-linux-x64-1.8.1/lib/:$LD_LIBRARY_PATH
|
||
```
|
||
|
||
**说明**:
|
||
|
||
- 把 `$(pwd)/build/lib` 添加到 `PYTHONPATH`，目的是为了加载 mmdeploy SDK python 包 `mmdeploy_python`，在章节 [SDK模型推理](#sdk模型推理)中讲述其用法。
|
||
- 在[使用 ONNX Runtime推理后端模型](#后端模型推理)时，需要加载自定义算子库，需要把 ONNX Runtime 库的路径加入环境变量 `LD_LIBRARY_PATH`中。
|
||
**方式三：** 源码安装
|
||
|
||
在方式一、二都满足不了的情况下，请参考[源码安装说明](../01-how-to-build/build_from_source.md) 安装 mmdeploy 以及所需推理引擎。
|
||
|
||
## 模型转换
|
||
|
||
你可以使用 [tools/deploy.py](https://github.com/open-mmlab/mmdeploy/blob/dev-1.x/tools/deploy.py) 把 mmrotate 模型一键式转换为推理后端模型。
|
||
该工具的详细使用说明请参考[这里](https://github.com/open-mmlab/mmdeploy/blob/master/docs/en/02-how-to-run/convert_model.md#usage).
|
||
|
||
以下，我们将演示如何把 `rotated-faster-rcnn` 转换为 onnx 模型。
|
||
|
||
```shell
|
||
cd mmdeploy
|
||
|
||
# download rotated-faster-rcnn model from mmrotate model zoo
|
||
mim download mmrotate --config rotated-faster-rcnn-le90_r50_fpn_1x_dota --dest .
|
||
wget https://github.com/open-mmlab/mmrotate/raw/main/demo/dota_demo.jpg
|
||
|
||
# convert mmrotate model to onnxruntime model with dynamic shape
|
||
python tools/deploy.py \
|
||
configs/mmrotate/rotated-detection_onnxruntime_dynamic.py \
|
||
rotated-faster-rcnn-le90_r50_fpn_1x_dota.py \
|
||
rotated_faster_rcnn_r50_fpn_1x_dota_le90-0393aa5c.pth \
|
||
dota_demo.jpg \
|
||
--work-dir mmdeploy_models/mmrotate/ort \
|
||
--device cpu \
|
||
--show \
|
||
--dump-info
|
||
```
|
||
|
||
转换的关键之一是使用正确的配置文件。项目中已内置了各后端部署[配置文件](https://github.com/open-mmlab/mmdeploy/tree/dev-1.x/configs/mmrotate)。
|
||
文件的命名模式是：
|
||
|
||
```
|
||
rotated_detection-{backend}-{precision}_{static | dynamic}_{shape}.py
|
||
```
|
||
|
||
其中：
|
||
|
||
- **{backend}:** 推理后端名称。比如，onnxruntime、tensorrt、pplnn、ncnn、openvino、coreml 等等
|
||
- **{precision}:** 推理精度。比如，fp16、int8。不填表示 fp32
|
||
- **{static | dynamic}:** 动态、静态 shape
|
||
- **{shape}:** 模型输入的 shape 或者 shape 范围
|
||
|
||
在上例中，你也可以把 `rotated-faster-rcnn` 转为其他后端模型。比如使用`rotated-detection_tensorrt-fp16_dynamic-320x320-1024x1024.py`，把模型转为 tensorrt-fp16 模型。
|
||
|
||
```{tip}
|
||
当转 tensorrt 模型时, --device 需要被设置为 "cuda"
|
||
```
|
||
|
||
## 模型规范
|
||
|
||
在使用转换后的模型进行推理之前，有必要了解转换结果的结构。 它存放在 `--work-dir` 指定的路路径下。
|
||
|
||
上例中的`mmdeploy_models/mmrotate/ort`，结构如下：
|
||
|
||
```
|
||
mmdeploy_models/mmrotate/ort
|
||
├── deploy.json
|
||
├── detail.json
|
||
├── end2end.onnx
|
||
└── pipeline.json
|
||
```
|
||
|
||
重要的是：
|
||
|
||
- **end2end.onnx**: 推理引擎文件。可用 ONNX Runtime 推理
|
||
- \***.json**: mmdeploy SDK 推理所需的 meta 信息
|
||
|
||
整个文件夹被定义为**mmdeploy SDK model**。换言之，**mmdeploy SDK model**既包括推理引擎，也包括推理 meta 信息。
|
||
|
||
## 模型推理
|
||
|
||
### 后端模型推理
|
||
|
||
以上述模型转换后的 `end2end.onnx` 为例，你可以使用如下代码进行推理：
|
||
|
||
```python
|
||
from mmdeploy.apis.utils import build_task_processor
|
||
from mmdeploy.utils import get_input_shape, load_config
|
||
import torch
|
||
|
||
deploy_cfg = 'configs/mmrotate/rotated-detection_onnxruntime_dynamic.py'
|
||
model_cfg = './rotated-faster-rcnn-le90_r50_fpn_1x_dota.py'
|
||
device = 'cpu'
|
||
backend_model = ['./mmdeploy_models/mmrotate/ort/end2end.onnx']
|
||
image = './dota_demo.jpg'
|
||
|
||
# read deploy_cfg and model_cfg
|
||
deploy_cfg, model_cfg = load_config(deploy_cfg, model_cfg)
|
||
|
||
# build task and backend model
|
||
task_processor = build_task_processor(model_cfg, deploy_cfg, device)
|
||
model = task_processor.build_backend_model(backend_model)
|
||
|
||
# process input image
|
||
input_shape = get_input_shape(deploy_cfg)
|
||
model_inputs, _ = task_processor.create_input(image, input_shape)
|
||
|
||
# do model inference
|
||
with torch.no_grad():
|
||
result = model.test_step(model_inputs)
|
||
|
||
# visualize results
|
||
task_processor.visualize(
|
||
image=image,
|
||
model=model,
|
||
result=result[0],
|
||
window_name='visualize',
|
||
output_file='./output.png')
|
||
```
|
||
|
||
### SDK 模型推理
|
||
|
||
你也可以参考如下代码，对 SDK model 进行推理：
|
||
|
||
```python
|
||
from mmdeploy_python import RotatedDetector
|
||
import cv2
|
||
import numpy as np
|
||
|
||
img = cv2.imread('./dota_demo.jpg')
|
||
|
||
# create a detector
|
||
detector = RotatedDetector(model_path='./mmdeploy_models/mmrotate/ort', device_name='cpu', device_id=0)
|
||
# perform inference
|
||
det = detector(img)
|
||
```
|
||
|
||
除了python API，mmdeploy SDK 还提供了诸如 C、C++、C#、Java等多语言接口。
|
||
你可以参考[样例](https://github.com/open-mmlab/mmdeploy/tree/dev-1.x/demo)学习其他语言接口的使用方法。
|
||
|
||
## 模型支持列表
|
||
|
||
| Model | OnnxRuntime | TensorRT |
|
||
| :------------------------------------------------------------------------------------------------ | :---------: | :------: |
|
||
| [Rotated RetinaNet](https://github.com/open-mmlab/mmrotate/blob/1.x/configs/rotated_retinanet) | Y | Y |
|
||
| [Rotated FasterRCNN](https://github.com/open-mmlab/mmrotate/blob/1.x/configs/rotated_faster_rcnn) | Y | Y |
|
||
| [Oriented R-CNN](https://github.com/open-mmlab/mmrotate/blob/1.x/configs/oriented_rcnn) | Y | Y |
|
||
| [Gliding Vertex](https://github.com/open-mmlab/mmrotate/blob/1.x/configs/gliding_vertex) | Y | Y |
|
||
| [RTMDET-R](https://github.com/open-mmlab/mmrotate/blob/dev-1.x/configs/rotated_rtmdet) | Y | Y |
|