评价此页
★ ★ ★ ★ ★
beginner/onnx/export_simple_model_to_onnx_tutorial

注意

转到末尾下载完整的示例代码。

ONNX 简介 || 将 PyTorch 模型导出到 ONNX || 扩展 ONNX 导出器算子支持 || 将带有控制流的模型导出到 ONNX

将 PyTorch 模型导出到 ONNX#

创建于: 2023 年 10 月 4 日 | 最后更新: 2025 年 7 月 11 日 | 最后验证: 2024 年 11 月 5 日

作者: Ti-Tai Wang, Justin Chu, Thiago Crepaldi。

注意

从 PyTorch 2.5 开始，有两个 ONNX 导出器选项可用。* torch.onnx.export(..., dynamo=True) 是推荐的导出器，它利用 torch.export 和 Torch FX 进行图捕获。* torch.onnx.export 是传统方法，依赖于已弃用的 TorchScript，不再推荐使用。

在 60 分钟闪电入门 中，我们有机会从宏观上了解 PyTorch，并训练了一个小型神经网络来分类图像。在本教程中，我们将扩展这一内容，介绍如何使用 torch.onnx.export(..., dynamo=True) ONNX 导出器将 PyTorch 中定义的模型转换为 ONNX 格式。

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

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

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

  1. 安装所需的依赖项。

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

  3. 将模型导出为 ONNX 格式。

  4. 将 ONNX 模型保存到文件中。

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

  6. 使用 ONNX Runtime 执行 ONNX 模型。

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

1. 安装所需的依赖项#

因为 ONNX 导出器使用 onnx 和 onnxscript 将 PyTorch 算子转换为 ONNX 算子，所以我们需要安装它们。

pip install --upgrade onnx onnxscript

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

一旦您的环境设置完毕，让我们开始用 PyTorch 对我们的图像分类器进行建模，就像我们在 60 分钟闪电入门 中所做的那样。

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


class ImageClassifierModel(nn.Module):
    def __init__(self):
        super().__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: torch.Tensor):
        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 = ImageClassifierModel()
# Create example inputs for exporting the model. The inputs should be a tuple of tensors.
example_inputs = (torch.randn(1, 1, 32, 32),)
onnx_program = torch.onnx.export(torch_model, example_inputs, dynamo=True)

[torch.onnx] Obtain model graph for `ImageClassifierModel([...]` with `torch.export.export(..., strict=False)`...
[torch.onnx] Obtain model graph for `ImageClassifierModel([...]` with `torch.export.export(..., strict=False)`... ✅
[torch.onnx] Run decomposition...
[torch.onnx] Run decomposition... ✅
[torch.onnx] Translate the graph into ONNX...
[torch.onnx] Translate the graph into ONNX... ✅

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

4. 将 ONNX 模型保存到文件中#

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

onnx_program.save("image_classifier_model.onnx")

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

import onnx

onnx_model = onnx.load("image_classifier_model.onnx")
onnx.checker.check_model(onnx_model)

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

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

../../_images/netron_web_ui.png

一旦 Netron 打开，我们可以将我们的 image_classifier_model.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_inputs = [tensor.numpy(force=True) for tensor in example_inputs]
print(f"Input length: {len(onnx_inputs)}")
print(f"Sample input: {onnx_inputs}")

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

onnxruntime_input = {input_arg.name: input_value for input_arg, input_value in zip(ort_session.get_inputs(), onnx_inputs)}

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

Input length: 1
Sample input: [array([[[[ 0.699791  ,  2.0654674 ,  0.9593781 , ..., -1.5100623 ,
          -0.04656836, -0.22803378],
         [-0.0291218 , -0.26293972,  0.5872927 , ..., -0.20636684,
          -0.12032283, -0.8408322 ],
         [-1.0400492 ,  1.3254217 ,  1.678506  , ..., -0.18104497,
           1.3355774 ,  0.44244853],
         ...,
         [-0.1968231 , -0.03848798,  0.73122704, ...,  0.50591975,
          -0.02238042, -0.12980133],
         [-2.0196671 , -1.4429339 ,  0.4121472 , ..., -0.71685475,
          -2.4095988 , -0.01927018],
         [ 1.7129555 ,  0.911029  , -0.4642682 , ...,  0.48035172,
          -1.3270918 , -0.9941012 ]]]], dtype=float32)]

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

确定导出的模型是否良好的最佳方法是通过与 PyTorch（我们的事实来源）进行数值评估。

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

torch_outputs = torch_model(*example_inputs)

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.08392321 -0.09688716  0.1699287   0.12951957 -0.00921483 -0.00022753
   0.0223255  -0.06088264  0.10227427 -0.04379771]]

结论#

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

延伸阅读#

下面的列表指的是从基本示例到高级场景的教程，不一定按列出的顺序列出。您可以随意直接跳到您感兴趣的特定主题，或者坐下来，愉快地浏览所有内容，以学习有关 ONNX 导出器的所有知识。

1. 将 PyTorch 模型导出到 ONNX
2. 扩展 ONNX 导出器算子支持
3. 将带控制流的模型导出到 ONNX

脚本总运行时间： (0 分 1.646 秒)

在此页面上
PyTorch 库