评价此页

演示 torch.export 流程、常见挑战及其解决方案#

作者: Ankith Gunapal, Jordi Ramon, Marcos Carranza

torch.export 入门教程中,我们学习了如何使用 torch.export。本教程在前一教程的基础上,探索了导出主流模型的代码流程,并解决了使用 torch.export 时可能遇到的常见挑战。

在本教程中,您将学习如何针对以下用例导出模型:

选择这四个模型是为了展示 torch.export 的独特功能,以及实施过程中面临的一些实际考量和问题。

先决条件#

  • PyTorch 2.4 或更高版本

  • torch.export 和 PyTorch Eager 推理的基本了解。

torch.export 的关键要求:无图中断 (No graph break)#

torch.compile 通过使用 JIT 将 PyTorch 代码编译为优化的内核来加速 PyTorch 代码。它使用 TorchDynamo 优化给定模型并创建优化后的计算图,然后使用 API 中指定的后端将其下沉(lowering)到硬件中。当 TorchDynamo 遇到不支持的 Python 特性时,它会中断计算图,让默认的 Python 解释器处理不支持的代码,然后恢复捕获计算图。这种计算图中的中断称为图中断 (graph break)

torch.exporttorch.compile 之间的主要区别之一是 torch.export 不支持图中断,这意味着您要导出的整个模型或模型的一部分必须是一个单一的计算图。这是因为处理图中断涉及使用默认的 Python 评估来解释不支持的操作,这与 torch.export 的设计初衷不兼容。您可以阅读此链接以了解各种 PyTorch 框架之间的详细差异。

您可以使用以下命令识别程序中的图中断:

TORCH_LOGS="graph_breaks" python <file_name>.py

您需要修改程序以消除图中断。一旦解决,您就可以导出模型了。PyTorch 针对流行 HuggingFace 和 TIMM 模型上的 torch.compile 运行每日基准测试。大多数这些模型都没有图中断。

本配方中的模型没有图中断,但在使用 torch.export 时会失败。

视频分类#

MViT 是一类基于多尺度视觉 Transformer 的模型。该模型已使用 Kinetics-400 数据集进行了视频分类训练。该模型结合相关数据集可用于游戏场景中的动作识别。

下面的代码通过以 batch_size=2 进行跟踪来导出 MViT,然后检查 ExportedProgram 是否可以使用 batch_size=4 运行。

import numpy as np
import torch
from torchvision.models.video import MViT_V1_B_Weights, mvit_v1_b
import traceback as tb

model = mvit_v1_b(weights=MViT_V1_B_Weights.DEFAULT)

# Create a batch of 2 videos, each with 16 frames of shape 224x224x3.
input_frames = torch.randn(2,16, 224, 224, 3)
# Transpose to get [1, 3, num_clips, height, width].
input_frames = np.transpose(input_frames, (0, 4, 1, 2, 3))

# Export the model.
exported_program = torch.export.export(
    model,
    (input_frames,),
)

# Create a batch of 4 videos, each with 16 frames of shape 224x224x3.
input_frames = torch.randn(4,16, 224, 224, 3)
input_frames = np.transpose(input_frames, (0, 4, 1, 2, 3))
try:
    exported_program.module()(input_frames)
except Exception:
    tb.print_exc()

错误:静态批量大小 (Static batch size)#

    raise RuntimeError(
RuntimeError: Expected input at *args[0].shape[0] to be equal to 2, but got 4

默认情况下,导出流程将假定所有输入形状都是静态的来跟踪程序,因此如果您使用与跟踪时不同的输入形状运行程序,将会遇到错误。

解决方案#

为了解决该错误,我们将输入的第一个维度 (batch_size) 指定为动态,并指定 batch_size 的预期范围。在下面显示的修正示例中,我们指定预期的 batch_size 可以从 1 到 16 不等。需要注意的一个细节是 min=2 并非 bug,详见 0/1 特化问题。有关 torch.export 动态形状的详细说明,请参阅导出教程。下面显示的代码演示了如何使用动态批量大小导出 mViT。

import numpy as np
import torch
from torchvision.models.video import MViT_V1_B_Weights, mvit_v1_b
import traceback as tb


model = mvit_v1_b(weights=MViT_V1_B_Weights.DEFAULT)

# Create a batch of 2 videos, each with 16 frames of shape 224x224x3.
input_frames = torch.randn(2,16, 224, 224, 3)

# Transpose to get [1, 3, num_clips, height, width].
input_frames = np.transpose(input_frames, (0, 4, 1, 2, 3))

# Export the model.
batch_dim = torch.export.Dim("batch", min=2, max=16)
exported_program = torch.export.export(
    model,
    (input_frames,),
    # Specify the first dimension of the input x as dynamic
    dynamic_shapes={"x": {0: batch_dim}},
)

# Create a batch of 4 videos, each with 16 frames of shape 224x224x3.
input_frames = torch.randn(4,16, 224, 224, 3)
input_frames = np.transpose(input_frames, (0, 4, 1, 2, 3))
try:
    exported_program.module()(input_frames)
except Exception:
    tb.print_exc()

自动语音识别#

自动语音识别 (ASR) 是利用机器学习将口语转录为文本。 Whisper 是 OpenAI 推出的基于 Transformer 的编码器-解码器模型,它在 68 万小时的标记数据上进行了 ASR 和语音翻译训练。下面的代码尝试导出用于 ASR 的 whisper-tiny 模型。

import torch
from transformers import WhisperProcessor, WhisperForConditionalGeneration
from datasets import load_dataset

# load model
model = WhisperForConditionalGeneration.from_pretrained("openai/whisper-tiny")

# dummy inputs for exporting the model
input_features = torch.randn(1,80, 3000)
attention_mask = torch.ones(1, 3000)
decoder_input_ids = torch.tensor([[1, 1, 1 , 1]]) * model.config.decoder_start_token_id

model.eval()

exported_program: torch.export.ExportedProgram= torch.export.export(model, args=(input_features, attention_mask, decoder_input_ids,))

错误:使用 TorchDynamo 进行严格跟踪 (strict tracing)#

torch._dynamo.exc.InternalTorchDynamoError: AttributeError: 'DynamicCache' object has no attribute 'key_cache'

默认情况下,torch.export 使用 TorchDynamo(一种字节码分析引擎)来跟踪您的代码,它会对代码进行符号分析并构建图。这种分析提供了更强的安全性保证,但并非所有 Python 代码都受支持。当我们使用默认的严格模式导出 whisper-tiny 模型时,由于存在不支持的功能,通常会在 Dynamo 中报错。要了解为什么 Dynamo 会报错,您可以参考此 GitHub Issue

解决方案#

为了解决上述错误,torch.export 支持 non_strict 模式,程序将使用 Python 解释器进行跟踪,其工作方式类似于 PyTorch Eager 执行。唯一的区别是所有 Tensor 对象都将被 ProxyTensors 替换,这些对象会将所有操作记录到图中。通过使用 strict=False,我们可以成功导出程序。

import torch
from transformers import WhisperProcessor, WhisperForConditionalGeneration
from datasets import load_dataset

# load model
model = WhisperForConditionalGeneration.from_pretrained("openai/whisper-tiny")

# dummy inputs for exporting the model
input_features = torch.randn(1,80, 3000)
attention_mask = torch.ones(1, 3000)
decoder_input_ids = torch.tensor([[1, 1, 1 , 1]]) * model.config.decoder_start_token_id

model.eval()

exported_program: torch.export.ExportedProgram= torch.export.export(model, args=(input_features, attention_mask, decoder_input_ids,), strict=False)

图像字幕生成#

图像字幕生成(Image Captioning)是使用文字定义图像内容的任务。在游戏语境下,图像字幕生成可用于通过动态生成场景中各种游戏对象的文本描述来增强游戏体验,从而为玩家提供更多详细信息。BLIP由 SalesForce Research 发布的一款流行的图像字幕生成模型。下面的代码尝试使用 batch_size=1 导出 BLIP。

import torch
from models.blip import blip_decoder

device = torch.device('cuda' if torch.cuda.is_available() else 'cpu')
image_size = 384
image = torch.randn(1, 3,384,384).to(device)
caption_input = ""

model_url = 'https://storage.googleapis.com/sfr-vision-language-research/BLIP/models/model_base_capfilt_large.pth'
model = blip_decoder(pretrained=model_url, image_size=image_size, vit='base')
model.eval()
model = model.to(device)

exported_program: torch.export.ExportedProgram= torch.export.export(model, args=(image,caption_input,), strict=False)

错误:无法改变具有冻结存储的张量 (Cannot mutate tensors with frozen storage)#

在导出模型时,它可能会失败,因为模型实现可能包含 torch.export 尚未支持的某些 Python 操作。其中一些失败可能有变通方法。BLIP 就是一个原始模型报错的例子,通过对代码进行少量修改即可解决。 torch.exportExportDB 中列出了常见的支持和不支持的操作案例,并展示了如何修改代码以使其兼容导出。

File "/BLIP/models/blip.py", line 112, in forward
    text.input_ids[:,0] = self.tokenizer.bos_token_id
  File "/anaconda3/envs/export/lib/python3.10/site-packages/torch/_subclasses/functional_tensor.py", line 545, in __torch_dispatch__
    outs_unwrapped = func._op_dk(
RuntimeError: cannot mutate tensors with frozen storage

解决方案#

克隆导出失败的张量

text.input_ids = text.input_ids.clone() # clone the tensor
text.input_ids[:,0] = self.tokenizer.bos_token_id

注意

此限制在 PyTorch 2.7 夜间版本中已放宽。这在 PyTorch 2.7 中应该可以直接工作。

可提示的图像分割#

图像分割是一种计算机视觉技术,它根据特征将数字图像划分为不同的像素组或片段。Segment Anything Model (SAM) 引入了可提示的图像分割,它根据指示所需对象的提示来预测对象掩码。SAM 2 是第一个用于跨图像和视频分割对象的统一模型。SAM2ImagePredictor 类为提示模型提供了一个简单的接口。该模型可以接受点和框提示作为输入,以及来自前一次预测迭代的掩码。由于 SAM2 在对象跟踪方面提供了强大的零样本性能,它可用于跟踪场景中的游戏对象。

SAM2ImagePredictor 的 predict 方法中的张量操作是在 _predict 方法中进行的。因此,我们尝试按如下方式导出。

ep = torch.export.export(
    self._predict,
    args=(unnorm_coords, labels, unnorm_box, mask_input, multimask_output),
    kwargs={"return_logits": return_logits},
    strict=False,
)

错误:模型不是 torch.nn.Module 类型#

torch.export 要求模块必须是 torch.nn.Module 类型。然而,我们试图导出的模块是一个类方法。因此它报错了。

Traceback (most recent call last):
  File "/sam2/image_predict.py", line 20, in <module>
    masks, scores, _ = predictor.predict(
  File "/sam2/sam2/sam2_image_predictor.py", line 312, in predict
    ep = torch.export.export(
  File "python3.10/site-packages/torch/export/__init__.py", line 359, in export
    raise ValueError(
ValueError: Expected `mod` to be an instance of `torch.nn.Module`, got <class 'method'>.

解决方案#

我们编写一个辅助类,继承自 torch.nn.Module,并在类的 forward 方法中调用 _predict 方法。完整代码可以在这里找到。

class ExportHelper(torch.nn.Module):
    def __init__(self):
        super().__init__()

    def forward(_, *args, **kwargs):
        return self._predict(*args, **kwargs)

 model_to_export = ExportHelper()
 ep = torch.export.export(
      model_to_export,
      args=(unnorm_coords, labels, unnorm_box, mask_input,  multimask_output),
      kwargs={"return_logits": return_logits},
      strict=False,
      )

结论#

在本教程中,我们学习了如何通过正确的配置和简单的代码修改来解决挑战,从而利用 torch.export 导出流行用例的模型。一旦能够导出模型,您就可以将 ExportedProgram 下沉到您的硬件中——服务器使用 AOTInductor,边缘设备使用 ExecuTorch。要了解有关 AOTInductor (AOTI) 的更多信息,请参阅 AOTI 教程。要了解有关 ExecuTorch 的更多信息,请参阅 ExecuTorch 教程