PyTorch 分类模型的转换及在 OpenCV Python 中启用

上一教程： 如何运行自定义 OCR 模型
下一教程： PyTorch 分类模型的转换及在 OpenCV C++ 中启用

原作者	Anastasia Murzova
兼容性	OpenCV >= 4.5

目标

在本教程中，您将了解如何

• 将 PyTorch 分类模型转换为 ONNX 格式
• 使用 OpenCV Python API 运行转换的 PyTorch 模型
• 获取对 PyTorch 和 OpenCV DNN 模型的评估。

我们将会通过 ResNet-50 架构的示例来探讨上述要点。

简介

让我们简要了解一下 PyTorch 模型与 OpenCV API 过渡管道中涉及的关键概念。将 PyTorch 模型转换为 cv.dnn.Net 的第一步是将模型转为 ONNX 格式。ONNX 的目的是在各种框架之间实现神经网络的互换性。PyTorch 中有一个用于 ONNX 转换的内置函数：torch.onnx.export。然后将获得的 .onnx 模型传递到 cv.dnn.readNetFromONNX。

要求

要能够对以下代码进行实验，您需要安装一组库。我们将为此使用装有 python3.7+ 的虚拟环境

virtualenv -p /usr/bin/python3.7 <env_dir_path>
source <env_dir_path>/bin/activate

对于从源代码构建 OpenCV-Python，请按照 OpenCV 简介 中相应的说明进行操作。

在开始安装这些库之前，您可以自定义 requirements.txt，排除或包括（例如，opencv-python）一些依赖项。以下行将把需求安装初始化到之前激活的虚拟环境中

pip install -r requirements.txt

实践

在本部分中，我们将介绍以下要点

1. 创建一个分类模型转换管道并提供推理
2. 评估和测试分类模型

如果您只想运行评估或测试模型管道，“模型转换管道”部分可以跳过。

模型转换管道

该子章节中的代码位于 dnn_model_runner 模块中，可通过以下代码行执行

python -m dnn_model_runner.dnn_conversion.pytorch.classification.py_to_py_resnet50

以下代码包含下面所列步骤的说明

1. 实例化 PyTorch 模型
2. 将 PyTorch 模型转化为 .onnx
3. 使用 OpenCV API 读入转化后的网络
4. 准备输入数据
5. 提供推理

# 初始化 PyTorch ResNet-50 模型
original_model = models.resnet50(pretrained=True)
 
# 获取转化为 ONNX PyTorch 模型的路径
full_model_path = get_pytorch_onnx_model(original_model)
 
# 使用 OpenCV API 读入转化后的 .onnx 模型
opencv_net = cv2.dnn.readNetFromONNX(full_model_path)
print("OpenCV 模型已成功读入。层 ID： \n", opencv_net.getLayerNames())
 
# 获取预处理的图像
input_img = get_preprocessed_img("../data/squirrel_cls.jpg")
 
# 获取 ImageNet 标签
imagenet_labels = get_imagenet_labels("../data/dnn/classification_classes_ILSVRC2012.txt")
 
# 获取 OpenCV DNN 预测
get_opencv_dnn_prediction(opencv_net, input_img, imagenet_labels)
 
# 获取原始 PyTorch ResNet50 预测
get_pytorch_dnn_prediction(original_model, input_img, imagenet_labels)

为了提供模型推理，我们将使用 下述松鼠照片 (CC0 许可证) 对应于 ImageNet 类的 ID 335

灰狐松鼠，东部灰狐松鼠，Sciurus niger

分类模型输入图像

对于所获取预测的标签解码，还需要 imagenet_classes.txt 文件，其中包含 ImageNet 类别的完整列表。

以预训练 PyTorch ResNet-50 为例，深入了解每个步骤

• 实例化 PyTorch ResNet-50 模型

# 初始化 PyTorch ResNet-50 模型
original_model = models.resnet50(pretrained=True)

• 将 PyTorch 模型转化为 ONNX

# 定义转化后模型的储存目录
onnx_model_path = "models"
# 定义转化后模型的名称
onnx_model_name = "resnet50.onnx"
 
# 创建转化后模型的目录
os.makedirs(onnx_model_path, exist_ok=True)
 
# 获取转化后模型的完整路径
full_model_path = os.path.join(onnx_model_path, onnx_model_name)
 
# 生成模型输入
generated_input = Variable(
torch.randn(1, 3, 224, 224)
)
 
# 将模型导出为 ONNX 格式
torch.onnx.export(
original_model,
generated_input,
full_model_path,
verbose=True,
input_names=["input"],
output_names=["output"],
opset_version=11
)

在成功执行上述代码之后，将获得 models/resnet50.onnx。

• 使用 cv.dnn.readNetFromONNX 读取已传输网络，并将上一步获得的 ONNX 模型传入其中

# 使用 OpenCV API 读入转化后的 .onnx 模型
opencv_net = cv2.dnn.readNetFromONNX(full_model_path)

• 准备输入数据

# 读取图像
input_img = cv2.imread(img_path, cv2.IMREAD_COLOR)
input_img = input_img.astype(np.float32)
 
input_img = cv2.resize(input_img, (256, 256))
 
# 定义预处理参数
mean = np.array([0.485, 0.456, 0.406]) * 255.0
scale = 1 / 255.0
std = [0.229, 0.224, 0.225]
 
# 准备输入 blob 以适应模型输入
# 1. 减去平均值
# 2. 按比例设置像素值，范围从 0 到 1
input_blob = cv2.dnn.blobFromImage(
image=input_img,
scalefactor=scale,
size=(224, 224), # img 目标大小
mean=mean,
swapRB=True, # BGR -> RGB
crop=True # 中心裁剪
)
# 3. 除以 std
input_blob[0] /= np.asarray(std, dtype=np.float32).reshape(3, 1, 1)

在此步骤中，我们读取图像，并使用 cv.dnn.blobFromImage 函数准备模型输入，该函数返回 4 变量 blob。需要注意的是，首先从 cv.dnn.blobFromImage 中减去平均值，然后再将像素值与比例相乘。因此，将 mean 乘以 255.0 以重现原始图像预处理顺序

img /= 255.0
img -= [0.485, 0.456, 0.406]
img /= [0.229, 0.224, 0.225]

• OpenCV cv.dnn.Net 推断

# 设置 OpenCV DNN 输入
opencv_net.setInput(preproc_img)
 
# OpenCV DNN 推断
out = opencv_net.forward()
print("OpenCV DNN 预测: \n")
print("* 形状: ", out.shape)
 
# 获取预测类 ID
imagenet_class_id = np.argmax(out)
 
# 获取置信度
confidence = out[0][imagenet_class_id]
print("* 类 ID: {}, 标签: {}".format(imagenet_class_id, imagenet_labels[imagenet_class_id]))
print("* 置信度: {:.4f}".format(confidence))

在执行上述代码后，我们将得到以下输出

OpenCV DNN 预测
* 形状: (1, 1000)
* 类 ID: 335，标签: 狐狸松鼠、东部狐狸松鼠、Sciurus niger
* 置信度: 14.8308

• PyTorch ResNet-50 模型推断

original_net.eval()
preproc_img = torch.FloatTensor(preproc_img)
 
# 推断
out = original_net(preproc_img)
print("\nPyTorch 模型预测: \n")
print("* 形状: ", out.shape)
 
# 获取预测类 ID
imagenet_class_id = torch.argmax(out, axis=1).item()
print("* 类 ID: {}, 标签: {}".format(imagenet_class_id, imagenet_labels[imagenet_class_id]))
 
# 获取置信度
confidence = out[0][imagenet_class_id]
print("* 置信度: {:.4f}".format(confidence.item()))

在启动上述代码后，我们将得到以下输出

PyTorch 模型预测
* 形状：torch.Size([1, 1000])
* 类 ID: 335，标签: 狐狸松鼠、东部狐狸松鼠、Sciurus niger
* 置信度: 14.8308

原始 ResNet-50 模型和 cv.dnn.Net 的推理结果相同。对于模型的扩展评估，我们可以使用 dnn_model_runner 模块中的 py_to_py_cls。模块部分将在下一小节中描述。

模型评估

在 samples/dnn 中提出的 dnn_model_runner 模块允许在 ImageNet 数据集上运行完整的评估管道，并测试以下 PyTorch 分类模型的执行情况

• alexnet
• vgg11
• vgg13
• vgg16
• vgg19
• resnet18
• resnet34
• resnet50
• resnet101
• resnet152
• squeezenet1_0
• squeezenet1_1
• resnext50_32x4d
• resnext101_32x8d
• wide_resnet50_2
• wide_resnet101_2

还可以使用其他适当的评估管道配置来扩展此列表。

评估模式

以下行表示以评估模式运行模块

python -m dnn_model_runner.dnn_conversion.pytorch.classification.py_to_py_cls --model_name <pytorch_cls_model_name>

从列表中选择的分类模型将读入 OpenCV cv.dnn.Net 对象。PyTorch 和 OpenCV 模型（准确性、推理时间、L1）的评估结果将写入日志文件。推理时间值还将显示在图表中以概括获得的模型信息。

必要的评估配置定义在 test_config.py 中，并且可以根据实际数据位置路径进行修改

@dataclass
class TestClsConfig
batch_size: int = 50
frame_size: int = 224
img_root_dir: str = "./ILSVRC2012_img_val"
    # 图像-类匹配的位置
img_cls_file: str = "./val.txt"
bgr_to_rgb: bool = True

要启动 PyTorch ResNet-50 的评估，请运行以下行

python -m dnn_model_runner.dnn_conversion.pytorch.classification.py_to_py_cls --model_name resnet50

在脚本启动后，包含评估数据的日志文件将在 dnn_model_runner/dnn_conversion/logs 中生成

模型 PyTorch resnet50 已成功获取并转换为 OpenCV DNN resnet50
===== 使用以下参数运行模型评估
* 验证数据位置：./ILSVRC2012_img_val
* 日志文件位置：dnn_model_runner/dnn_conversion/logs/PyTorch_resnet50_log.txt

测试模式

以下行表示以测试模式运行模块，即它提供了模型推理的步骤

python -m dnn_model_runner.dnn_conversion.pytorch.classification.py_to_py_cls --model_name <pytorch_cls_model_name> --test True --default_img_preprocess <True/False> --evaluate False

在这里，default_img_preprocess 键定义的是您是希望用一些特定值对模型测试流程进行参数化还是使用默认值，例如 scale、mean 或 std。

测试配置在 test_config.py TestClsModuleConfig 类中表示

@dataclass
class TestClsModuleConfig
cls_test_data_dir: str = "../data"
test_module_name: str = "classification"
test_module_path: str = "classification.py"
input_img: str = os.path.join(cls_test_data_dir, "squirrel_cls.jpg")
model: str = ""
 
frame_height: str = str(TestClsConfig.frame_size)
frame_width: str = str(TestClsConfig.frame_size)
scale: str = "1.0"
mean: List[str] = field(default_factory=lambda: ["0.0", "0.0", "0.0"])
std: List[str] = field(default_factory=list)
crop: str = "False"
rgb: str = "True"
rsz_height: str = ""
rsz_width: str = ""
classes: str = os.path.join(cls_test_data_dir, "dnn", "classification_classes_ILSVRC2012.txt")

默认图像预处理选项在 default_preprocess_config.py 中定义。例如

BASE_IMG_SCALE_FACTOR = 1 / 255.0
PYTORCH_RSZ_HEIGHT = 256
PYTORCH_RSZ_WIDTH = 256
 
pytorch_resize_input_blob = {
    "mean": ["123.675", "116.28", "103.53"],
    "scale": str(BASE_IMG_SCALE_FACTOR),
    "std": ["0.229", "0.224", "0.225"],
    "crop": "True",
    "rgb": "True",
    "rsz_height": str(PYTORCH_RSZ_HEIGHT),
    "rsz_width": str(PYTORCH_RSZ_WIDTH)
}

模型测试的基础在 samples/dnn/classification.py 中表示。classification.py 可以使用 --input 中提供的已转换模型，以及 cv.dnn.blobFromImage 的填充参数来独立执行。

要从头重现“模型转换管道”中所述的 OpenCV 步骤，使用 dnn_model_runner 执行以下行

python -m dnn_model_runner.dnn_conversion.pytorch.classification.py_to_py_cls --model_name resnet50 --test True --default_img_preprocess True --evaluate False

神经网络预测显示在输出窗口的左上角

ResNet50 OpenCV 推理输出