# YOLO12 部署示例

该示例来自 [yolo12](https://docs.ultralytics.com/models/yolo12/) 项目, 权重使用的是 [yolo12n.pt](https://github.com/ultralytics/assets/releases/download/v8.3.0/yolo12n.pt)。

整体步骤如下：

1. 导出 ONNX 模型并转换成 SG-IR(以下简称 sg 文件)，用于后续步骤的量化和编译。
2. 准备量化校准数据集，使用 rbcc 量化 sg 得到量化后的 sg。
3. 使用 rbcc 对量化后的 sg 进行编译，生成可在 CAISA 芯片上执行的 rbo 文件。
4. 对 rbo 进行性能测试和精度测试。

**目录**

- [YOLO12 部署示例](#yolo12-部署示例)
  - [0. 模型与数据集下载](#0-模型与数据集下载)
  - [1. 模型转换](#1-模型转换)
    - [1.1 模型优化](#11-模型优化)
  - [2. 模型量化](#2-模型量化)
  - [3. 模型编译](#3-模型编译)
  - [4. 模型测试](#4-模型测试)
    - [4.1 单张图像测试](#41-单张图像测试)
    - [4.2 精度测试](#42-精度测试)
    - [4.3 性能测试](#43-性能测试)

## 0. 模型与数据集下载

为了快速体验 CAISA 430 芯片，我们提供了预编译好的 sg、onnx 和 rbo 文件，您可选择快速从任一步骤开始。

1. [量化校准数据集](https://modelzoo.oss-cn-shenzhen.aliyuncs.com/COCO2017_Quantization_100.zip)
2. [测试数据集](https://modelzoo.oss-cn-shenzhen.aliyuncs.com/COCO2017.zip)
3. [onnx 模型](https://modelzoo.oss-cn-shenzhen.aliyuncs.com/onnxs/yolo12n.onnx)
4. [量化后的 sg](https://modelzoo.oss-cn-shenzhen.aliyuncs.com/sgs/yolo12n_8bit.sg)
5. [rbo](https://modelzoo.oss-cn-shenzhen.aliyuncs.com/rbos/yolo12n.rbo)

## 1. 模型转换

使用 `ultralytics` 项目导出 `yolo12n.onnx` 步骤如下：

```shell
pip install ultralytics
```

导出 onnx：

```python
from ultralytics import YOLO

model = YOLO('yolo12n.pt', task='detect')
model_path = model.export(format="onnx", dynamic=False, simplify=True, device="cpu", nms=False)
print(f"saved on {model_path}.")
```

也可从[模型与数据集下载](#0-模型与数据集下载)提供的链接下载 `yolo12n.onnx`，

使用 `mkdir outputs` 新建 outputs 文件夹，把 `yolo12n.onnx` 模型移动到 `outputs` 文件夹内。

从 onnx 模型导出 sg：

```shell
$ rbcc parse --onnx outputs/yolo12n.onnx --sg outputs/yolo12n.sg 
The version of rbcc installed is 1.1.5, librbcc: Not Installed
2025-04-07 15:03:21 - RBCC - INFO - Start parse 'yolo12n.onnx' onnx model.
2025-04-07 15:03:26 - RBCC - INFO - ONNX model parsed successfully.
2025-04-07 15:03:26 - RBCC - INFO - Model's input  0: name=images, shape=[1, 640, 640, 3], dtype=float32.
2025-04-07 15:03:26 - RBCC - INFO - Model's output 0: name=output0, shape=[1, 84, 8400], dtype=float32.
SG IR saved in outputs/yolo12n.sg
```

> 注：rbcc parse 命令行默认会对输入 [Batch, Channel, Height, Width] 转换成 [Batch, Height, Width, Channel] 格式。

### 1.1 模型优化

为了提高模型在硬件设备上的推理性能，可以对模型图结构进行优化：

```shell
python rewriter_sg.py outputs/yolo12n.sg 
```

## 2. 模型量化

在量化操作之前，我们需要从训练数据集中随机抽取 100 至 200 个样本，作为量化校准数据集。在进行量化前请先从[模型与数据集下载](#0-模型与数据集下载)提供的链接中下载量化校准数据集 `COCO2017_Quantization_100.zip` 到该文件夹内。

解压 `COCO2017_Quantization_100.zip` 后量化 sg：

```shell
$ python quantize_sg.py outputs/yolo12n.sg COCO2017_Quantization_100
Quantize Calibration - Histogram: 200sample [00:13, 15.13sample/s]
```

> 为了减小模型的量化损失，我们采用了 `WeightReconQunatizer` 量化方法，该方法可以通过学习一组自适应的舍入参数，来优化每个权重的舍入方式。并且对网络输出采用了 16-bit 量化，
以保证模型量化精度损失在可接受范围内。具体设置请参考 rbcc 手册量化部分。
> 该示例可用于您集成到代码环境中的参考。

## 3. 模型编译

获得量化后的 sg 后，使用 `rbcc gen` 即可快速完成 rbo 编译：

```shell
$ rbcc gen --sg outputs/yolo12n_8bit.sg --rbo outputs/yolo12n.rbo --config env.json
The version of rbcc installed is 1.2.0
2025-05-06 11:10:28 - RBCC - INFO - Start loading 'outputs/yolo12n_8bit.sg'.
2025-05-06 11:10:28 - RBCC - INFO - Loading sg end.
2025-05-06 11:10:28 - RBCC - INFO - Start compiling the model and generate rbo.
2025-05-06 11:10:30 - RBCC - INFO - Compilation is completed, rbo has been saved to 'outputs/yolo12n.rbo'.
```

> `--config env.json` 指定编译优化项，使用后模型性能更佳。

## 4. 模型测试

成功编译生成 rbo 后，我们需要把 rbo 文件拷贝到 CAISA 430 芯片上进行精度测试和性能测试。以下精度评估使用了远程调用的方式，环境准备参考 [rbo 远程调用](../rbo_exe.md)。

使用 scp 将 `yolo12n.rbo` 上传到 CAISA 430 设备可访问的路径：

```shell
scp outputs/yolo12n.rbo root@192.168.12.169:/data/yolo12n.rbo
```

### 4.1 单张图像测试

通过远程调用，我们也可以快速测试 rbo 单张图片的结果：

```shell
python demo.py /data/yolo12n.rbo ../../imgs/demo.jpg
```

### 4.2 精度测试

全数据集精度测试：

| Model        | DataSet        | dtype  | mAP<sup>val<br>50-95 | mAP<sup>val<br>50 |
| ------------ | -------------- | ------ | -------------------- | ----------------- |
| YOLOv12n     | COCO2017(5k)   | fp32   | 40.7                 | 56.7              |
| YOLOv12n-sg  | COCO2017(5k)   | uint8  | 39.9                 | 56.1              |
| YOLOv12n-rbo | COCO2017(5k)   | uint8  | 39.8                 | 55.9              |

部分数据集精度测试（前 500 imgs）：

| Model       | DataSet         | dtype  | mAP<sup>val<br>50-95 | mAP<sup>val<br>50 |
| ----------- | --------------- | ------ | -------------------- | ----------------- |
| YOLOv5n     | COCO2017(500)   | fp32   | 45.4                 | 61.7              |
| YOLOv5n-sg  | COCO2017(500)   | uint8  | 44.8                 | 61.0              |
| YOLOv5n-rbo | COCO2017(500)   | uint8  | 44.6                 | 60.5              |

该模型使用 COCO2017 数据集进行精度评估，请先在[模型与数据集下载](#0-模型与数据集下载)中下载测试数据集，测试集结构如下：

```shell
└── COCO2017
    ├── annotations             # 图片标签
    └── val2017                 # 测试图片, 共 5000 张
```

评估方式如下：

```shell
python ../../tools/eval_coco.py \
    /data/yolo12n.rbo \
    --preprocess-py preprocess.py \
    --data ~/datasets/COCO2017 \
    --yolo-coco \
    --device-id 0
```

若 rbo 精度相比原浮点模型精度下降过多，无法确定具体原因时，我们建议先测试 sg，它作为 rbo 的编译输入，它的结果也至关重要，sg 精度测试方式如下：

```shell
python ../../tools/eval_coco.py \
    outputs/yolo12n_8bit.sg \
    --preprocess-py preprocess.py \
    --data ~/datasets/COCO2017 \
    --yolo-coco \
    --device-id 0
```

> sg 使用 Pytorch 作为运行后端，并模拟量化计算过程，故其精度和 rbo 精度会有些许区别，这属于正常现象。

### 4.3 性能测试

参考 [rbo 性能测试](../rbo_perf.md)