torch.onnx.verification

ONNX 验证模块提供了一套工具，用于验证 ONNX 模型的正确性。

torch.onnx.verification.verify_onnx_program(onnx_program, args=None, kwargs=None, compare_intermediates=False)

通过将 ONNX 模型的值与来自 ExportedProgram 的预期值进行比较来验证 ONNX 模型。

参数

• onnx_program (_onnx_program.ONNXProgram) – 要验证的 ONNX program。

• args (tuple[Any, ...] | None) – 模型的输入参数。

• kwargs (dict[str, Any] | None) – 模型的关键字参数。

• compare_intermediates (bool) – 是否验证中间值。这将花费更长时间，因此默认禁用。

返回

包含每个值的验证信息的 VerificationInfo 对象。

返回类型

list[VerificationInfo]

class torch.onnx.verification.VerificationInfo(name, max_abs_diff, max_rel_diff, abs_diff_hist, rel_diff_hist, expected_dtype, actual_dtype)

ONNX program 中某个值的验证信息。

此类包含最大绝对差值、最大相对差值以及预期值与实际值之间绝对差值和相对差值的直方图。它还包括预期和实际数据类型。

直方图表示为张量的元组，其中第一个张量是直方图计数，第二个张量是 bin 边界。

变量

• name (str) – 值的名称（输出或中间值）。

• max_abs_diff (float) – 预期值与实际值之间的最大绝对差值。

• max_rel_diff (float) – 预期值与实际值之间的最大相对差值。

• abs_diff_hist (tuple[torch.Tensor, torch.Tensor]) – 表示绝对差值直方图的张量元组。第一个张量是直方图计数，第二个张量是 bin 边界。

• rel_diff_hist (tuple[torch.Tensor, torch.Tensor]) – 表示相对差值直方图的张量元组。第一个张量是直方图计数，第二个张量是 bin 边界。

• expected_dtype (torch.dtype) – 预期值的数据类型。

• actual_dtype (torch.dtype) – 实际值的数据类型。

classmethod from_tensors(name, expected, actual)

从两个张量创建一个 VerificationInfo 对象。

参数

• name (str) – 值的名称。

• expected (torch.Tensor | float | int | bool) – 预期张量。

• actual (torch.Tensor | float | int | bool) – 实际张量。

返回

VerificationInfo 对象。

返回类型

VerificationInfo

torch.onnx.verification.verify(model, input_args, input_kwargs=None, do_constant_folding=True, dynamic_axes=None, input_names=None, output_names=None, training=<TrainingMode.EVAL: 0>, opset_version=None, keep_initializers_as_inputs=True, verbose=False, fixed_batch_size=False, use_external_data=False, additional_test_inputs=None, options=None)

验证模型导出到 ONNX 是否与原始 PyTorch 模型一致。

自版本 2.7 起已弃用: 考虑使用 torch.onnx.export(..., dynamo=True) 并使用返回的 ONNXProgram 来测试 ONNX 模型。

参数

• model (_ModelType) – 参见 torch.onnx.export()。

• input_args (_InputArgsType) – 参见 torch.onnx.export()。

• input_kwargs (_InputKwargsType | None) – 参见 torch.onnx.export()。

• do_constant_folding (bool) – 参见 torch.onnx.export()。

• dynamic_axes (Mapping[str, Mapping[int, str] | Mapping[str, Sequence[int]]] | None) – 参见 torch.onnx.export()。

• input_names (Sequence[str] | None) – 参见 torch.onnx.export()。

• output_names (Sequence[str] | None) – 参见 torch.onnx.export()。

• training (_C_onnx.TrainingMode) – 参见 torch.onnx.export()。

• opset_version (int | None) – 参见 torch.onnx.export()。

• keep_initializers_as_inputs (bool) – 参见 torch.onnx.export()。

• verbose (bool) – 参见 torch.onnx.export()。

• fixed_batch_size (bool) – 遗留参数，仅用于 RNN 测试用例。

• use_external_data (bool) – 明确指定是否使用外部数据导出模型。

• additional_test_inputs (Sequence[_InputArgsType] | None) – 元组列表。每个元组是一组要测试的输入参数。当前仅支持 *args。

• options (VerificationOptions | None) – 一个控制验证行为的 VerificationOptions 对象。

触发

• AssertionError – 如果 ONNX 模型和 PyTorch 模型的输出在指定精度内不相等。

• ValueError – 如果提供的参数无效。

已弃用

以下类和函数已弃用。

class torch.onnx.verification.check_export_model_diff

class torch.onnx.verification.GraphInfo

class torch.onnx.verification.GraphInfoPrettyPrinter

class torch.onnx.verification.OnnxBackend

class torch.onnx.verification.OnnxTestCaseRepro

class torch.onnx.verification.VerificationOptions

torch.onnx.verification.find_mismatch()

torch.onnx.verification.verify_aten_graph()