注意

单击此处下载完整的示例代码

ONNX 简介 || 将 PyTorch 模型导出到 ONNX || 扩展 ONNX 注册表

将 PyTorch 模型导出到 ONNX

创建于：2023 年 10 月 04 日 | 最后更新：2025 年 1 月 27 日 | 最后验证：2024 年 11 月 05 日

注意

截至 PyTorch 2.1，ONNX Exporter 有两个版本。

torch.onnx.dynamo_export 是最新的（仍处于 beta 阶段）导出器，基于 PyTorch 2.0 发布的 TorchDynamo 技术
torch.onnx.export 基于 TorchScript 后端，自 PyTorch 1.2.0 起可用

在60 分钟速成教程中，我们有机会从高层次了解 PyTorch，并训练一个小型神经网络来分类图像。在本教程中，我们将在此基础上进行扩展，描述如何使用 TorchDynamo 和 torch.onnx.dynamo_export ONNX 导出器将 PyTorch 中定义的模型转换为 ONNX 格式。

虽然 PyTorch 非常适合迭代模型开发，但可以使用不同的格式将模型部署到生产环境，包括 ONNX (开放神经网络交换)！

ONNX 是一种灵活的开放标准格式，用于表示机器学习模型，机器学习的标准化表示使其能够在各种硬件平台和运行时环境中执行，从大型云端超级计算机到资源受限的边缘设备，例如您的 Web 浏览器和手机。

在本教程中，我们将学习如何：

安装所需的依赖项。
编写一个简单的图像分类器模型。
将模型导出为 ONNX 格式。
将 ONNX 模型保存在文件中。
使用 Netron 可视化 ONNX 模型图。
使用 ONNX Runtime 执行 ONNX 模型
将 PyTorch 结果与 ONNX Runtime 的结果进行比较。

1. 安装所需的依赖项

由于 ONNX 导出器使用 onnx 和 onnxscript 将 PyTorch 运算符转换为 ONNX 运算符，因此我们需要安装它们。

pip install onnx
pip install onnxscript

2. 编写一个简单的图像分类器模型

环境设置完成后，让我们开始使用 PyTorch 对图像分类器进行建模，就像我们在60 分钟速成教程中所做的那样。

import torch
import torch.nn as nn
import torch.nn.functional as F


class MyModel(nn.Module):

    def __init__(self):
        super(MyModel, self).__init__()
        self.conv1 = nn.Conv2d(1, 6, 5)
        self.conv2 = nn.Conv2d(6, 16, 5)
        self.fc1 = nn.Linear(16 * 5 * 5, 120)
        self.fc2 = nn.Linear(120, 84)
        self.fc3 = nn.Linear(84, 10)

    def forward(self, x):
        x = F.max_pool2d(F.relu(self.conv1(x)), (2, 2))
        x = F.max_pool2d(F.relu(self.conv2(x)), 2)
        x = torch.flatten(x, 1)
        x = F.relu(self.fc1(x))
        x = F.relu(self.fc2(x))
        x = self.fc3(x)
        return x

3. 将模型导出为 ONNX 格式

现在我们已经定义了模型，我们需要实例化它并创建一个随机的 32x32 输入。接下来，我们可以将模型导出为 ONNX 格式。

torch_model = MyModel()
torch_input = torch.randn(1, 1, 32, 32)
onnx_program = torch.onnx.dynamo_export(torch_model, torch_input)

/usr/local/lib/python3.10/dist-packages/onnxscript/converter.py:823: FutureWarning:

'onnxscript.values.Op.param_schemas' is deprecated in version 0.1 and will be removed in the future. Please use '.op_signature' instead.

/usr/local/lib/python3.10/dist-packages/onnxscript/converter.py:823: FutureWarning:

'onnxscript.values.OnnxFunction.param_schemas' is deprecated in version 0.1 and will be removed in the future. Please use '.op_signature' instead.

/usr/local/lib/python3.10/dist-packages/torch/onnx/_internal/_exporter_legacy.py:101: UserWarning:

torch.onnx.dynamo_export only implements opset version 18 for now. If you need to use a different opset version, please register them with register_custom_op.

/usr/local/lib/python3.10/dist-packages/torch/onnx/_internal/fx/onnxfunction_dispatcher.py:503: FutureWarning:

'onnxscript.values.TracedOnnxFunction.param_schemas' is deprecated in version 0.1 and will be removed in the future. Please use '.op_signature' instead.

正如我们所看到的，我们不需要对模型进行任何代码更改。生成的 ONNX 模型存储在 torch.onnx.ONNXProgram 中，作为二进制 protobuf 文件。

4. 将 ONNX 模型保存在文件中

虽然将导出的模型加载到内存中在许多应用程序中很有用，但我们可以使用以下代码将其保存到磁盘

onnx_program.save("my_image_classifier.onnx")

您可以将 ONNX 文件加载回内存，并使用以下代码检查其格式是否正确

import onnx
onnx_model = onnx.load("my_image_classifier.onnx")
onnx.checker.check_model(onnx_model)

5. 使用 Netron 可视化 ONNX 模型图

现在我们已经将模型保存在文件中，我们可以使用 Netron 可视化它。Netron 可以安装在 macOS、Linux 或 Windows 计算机上，也可以直接从浏览器运行。让我们尝试 Web 版本，打开以下链接：https://netron.app/。

打开 Netron 后，我们可以将我们的 my_image_classifier.onnx 文件拖放到浏览器中，或者在单击“打开模型”按钮后选择它。

../../_images/image_classifier_onnx_model_on_netron_web_ui.png

就是这样！我们已成功将 PyTorch 模型导出为 ONNX 格式，并使用 Netron 可视化了它。

6. 使用 ONNX Runtime 执行 ONNX 模型

最后一步是使用 ONNX Runtime 执行 ONNX 模型，但在执行此操作之前，让我们安装 ONNX Runtime。

pip install onnxruntime

ONNX 标准不支持 PyTorch 支持的所有数据结构和类型，因此我们需要在将 PyTorch 输入馈送到 ONNX Runtime 之前，使其适应 ONNX 格式。在我们的示例中，输入恰好相同，但在更复杂的模型中，它可能比原始 PyTorch 模型有更多输入。

ONNX Runtime 需要一个额外的步骤，包括将所有 PyTorch 张量转换为 Numpy（在 CPU 中），并将它们包装在一个字典中，其中键是一个字符串，输入名称作为键，numpy 张量作为值。

现在我们可以创建一个ONNX Runtime 推理会话，使用处理后的输入执行 ONNX 模型并获取输出。在本教程中，ONNX Runtime 在 CPU 上执行，但它也可以在 GPU 上执行。

import onnxruntime

onnx_input = [torch_input]
print(f"Input length: {len(onnx_input)}")
print(f"Sample input: {onnx_input}")

ort_session = onnxruntime.InferenceSession("./my_image_classifier.onnx", providers=['CPUExecutionProvider'])

def to_numpy(tensor):
    return tensor.detach().cpu().numpy() if tensor.requires_grad else tensor.cpu().numpy()

onnxruntime_input = {k.name: to_numpy(v) for k, v in zip(ort_session.get_inputs(), onnx_input)}

# onnxruntime returns a list of outputs
onnxruntime_outputs = ort_session.run(None, onnxruntime_input)[0]

Input length: 1
Sample input: [tensor([[[[-1.0416,  1.1125, -0.3602,  ..., -0.0189, -1.2205,  0.3472],
          [ 0.6651,  1.1037, -0.3674,  ..., -1.4724,  0.2539, -0.0788],
          [-0.1239, -0.6458, -0.7785,  ..., -0.2674,  0.3019, -0.5682],
          ...,
          [-0.0300, -0.4833, -0.3928,  ..., -1.2406,  0.8488, -0.5473],
          [-0.8185, -0.1276,  0.3475,  ..., -1.0702, -1.6922, -0.6048],
          [ 0.8268, -0.0248, -0.3354,  ..., -0.9178, -0.3240,  0.7485]]]])]

7. 将 PyTorch 结果与 ONNX Runtime 的结果进行比较

确定导出模型是否良好的最佳方法是通过针对 PyTorch 进行数值评估，PyTorch 是我们的真值来源。

为此，我们需要使用相同的输入执行 PyTorch 模型，并将结果与 ONNX Runtime 的结果进行比较。在比较结果之前，我们需要转换 PyTorch 的输出以匹配 ONNX 的格式。

torch_outputs = torch_model(torch_input)

assert len(torch_outputs) == len(onnxruntime_outputs)
for torch_output, onnxruntime_output in zip(torch_outputs, onnxruntime_outputs):
    torch.testing.assert_close(torch_output, torch.tensor(onnxruntime_output))

print("PyTorch and ONNX Runtime output matched!")
print(f"Output length: {len(onnxruntime_outputs)}")
print(f"Sample output: {onnxruntime_outputs}")

PyTorch and ONNX Runtime output matched!
Output length: 1
Sample output: [[ 0.14531787 -0.05903321 -0.00652155  0.09054166  0.01458297 -0.08046442
  -0.12109031 -0.03938238 -0.01814789 -0.01363543]]

结论

差不多就是这样！我们已成功将 PyTorch 模型导出为 ONNX 格式，将模型保存到磁盘，使用 Netron 查看它，使用 ONNX Runtime 执行它，并最终将其数值结果与 PyTorch 的结果进行了比较。

进一步阅读

以下列表指的是从基本示例到高级场景的教程，不一定按照列出的顺序排列。您可以随意直接跳转到您感兴趣的特定主题，或者坐稳扶好，愉快地浏览所有主题，了解有关 ONNX 导出器的所有信息。

1. 将 PyTorch 模型导出到 ONNX

2. 扩展 ONNX 注册表

脚本的总运行时间：（0 分钟 1.749 秒）

由 Sphinx-Gallery 生成的图库