注意

点击这里下载完整示例代码

TorchScript 简介¶

创建于: 2019 年 8 月 9 日 | 最后更新于: 2024 年 12 月 2 日 | 最后验证于: 2024 年 11 月 5 日

作者: James Reed (jamesreed@fb.com), Michael Suo (suo@fb.com), rev2

警告

TorchScript 不再积极开发。

本教程是 TorchScript 的简介。TorchScript 是 PyTorch 模型（nn.Module 的子类）的一种中间表示，可以在高性能环境（如 C++）中运行。

在本教程中，我们将介绍

在 PyTorch 中编写模型的基础知识，包括

Modules
定义 forward 函数
将模块组合成模块层次结构

将 PyTorch 模块转换为 TorchScript（我们的高性能部署运行时）的具体方法

Tracing 现有模块
使用 scripting 直接编译模块
如何结合使用这两种方法
保存和加载 TorchScript 模块

我们希望在完成本教程后，您可以继续学习后续教程，该教程将引导您完成从 C++ 中实际调用 TorchScript 模型的示例。

import torch  # This is all you need to use both PyTorch and TorchScript!
print(torch.__version__)
torch.manual_seed(191009)  # set the seed for reproducibility

2.7.0+cu126

<torch._C.Generator object at 0x7f5ee6596470>

PyTorch 模型编写基础¶

让我们从定义一个简单的 Module 开始。Module 是 PyTorch 中基本的组合单元。它包含

一个构造函数，用于准备模块以供调用
一组 Parameters 和子 Modules。这些由构造函数初始化，并在调用期间由模块使用。
一个 forward 函数。这是调用模块时运行的代码。

让我们看一个小例子

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

    def forward(self, x, h):
        new_h = torch.tanh(x + h)
        return new_h, new_h

my_cell = MyCell()
x = torch.rand(3, 4)
h = torch.rand(3, 4)
print(my_cell(x, h))

(tensor([[0.8219, 0.8990, 0.6670, 0.8277],
        [0.5176, 0.4017, 0.8545, 0.7336],
        [0.6013, 0.6992, 0.2618, 0.6668]]), tensor([[0.8219, 0.8990, 0.6670, 0.8277],
        [0.5176, 0.4017, 0.8545, 0.7336],
        [0.6013, 0.6992, 0.2618, 0.6668]]))

我们已经

创建了一个继承自 torch.nn.Module 的类。
定义了一个构造函数。该构造函数没有做太多事情，只是调用了 super 的构造函数。
定义了一个 forward 函数，它接受两个输入并返回两个输出。forward 函数的实际内容并不重要，但它有点像一个虚假的 RNN cell——也就是说——它是一个在循环中应用的函数。

我们实例化了模块，并创建了 x 和 h，它们只是 3x4 的随机值矩阵。然后我们使用 my_cell(x, h) 调用了 cell。这反过来会调用我们的 forward 函数。

让我们做一些更有趣的事情

class MyCell(torch.nn.Module):
    def __init__(self):
        super(MyCell, self).__init__()
        self.linear = torch.nn.Linear(4, 4)

    def forward(self, x, h):
        new_h = torch.tanh(self.linear(x) + h)
        return new_h, new_h

my_cell = MyCell()
print(my_cell)
print(my_cell(x, h))

MyCell(
  (linear): Linear(in_features=4, out_features=4, bias=True)
)
(tensor([[ 0.8573,  0.6190,  0.5774,  0.7869],
        [ 0.3326,  0.0530,  0.0702,  0.8114],
        [ 0.7818, -0.0506,  0.4039,  0.7967]], grad_fn=<TanhBackward0>), tensor([[ 0.8573,  0.6190,  0.5774,  0.7869],
        [ 0.3326,  0.0530,  0.0702,  0.8114],
        [ 0.7818, -0.0506,  0.4039,  0.7967]], grad_fn=<TanhBackward0>))

我们重新定义了模块 MyCell，但这次我们添加了一个 self.linear 属性，并在 forward 函数中调用了 self.linear。

这里到底发生了什么？torch.nn.Linear 是 PyTorch 标准库中的一个 Module。就像 MyCell 一样，它可以使用调用语法进行调用。我们正在构建一个 Module 的层次结构。

对 Module 使用 print 将提供 Module 子类层次结构的可视化表示。在我们的例子中，我们可以看到我们的 Linear 子类及其参数。

通过以这种方式组合 Module，我们可以简洁且易读地使用可重用组件编写模型。

您可能注意到输出上的 grad_fn。这是 PyTorch 自动微分方法的一个细节，该方法称为 autograd。简而言之，该系统允许我们计算通过潜在复杂程序的导数。这种设计在模型编写方面提供了极大的灵活性。

现在让我们看看这种灵活性

class MyDecisionGate(torch.nn.Module):
    def forward(self, x):
        if x.sum() > 0:
            return x
        else:
            return -x

class MyCell(torch.nn.Module):
    def __init__(self):
        super(MyCell, self).__init__()
        self.dg = MyDecisionGate()
        self.linear = torch.nn.Linear(4, 4)

    def forward(self, x, h):
        new_h = torch.tanh(self.dg(self.linear(x)) + h)
        return new_h, new_h

my_cell = MyCell()
print(my_cell)
print(my_cell(x, h))

MyCell(
  (dg): MyDecisionGate()
  (linear): Linear(in_features=4, out_features=4, bias=True)
)
(tensor([[ 0.8346,  0.5931,  0.2097,  0.8232],
        [ 0.2340, -0.1254,  0.2679,  0.8064],
        [ 0.6231,  0.1494, -0.3110,  0.7865]], grad_fn=<TanhBackward0>), tensor([[ 0.8346,  0.5931,  0.2097,  0.8232],
        [ 0.2340, -0.1254,  0.2679,  0.8064],
        [ 0.6231,  0.1494, -0.3110,  0.7865]], grad_fn=<TanhBackward0>))

我们再次重新定义了 MyCell 类，但在这里我们定义了 MyDecisionGate。该模块使用了 控制流。控制流包括循环和 if 语句等内容。

许多框架采用给定完整程序表示来计算符号导数的方法。然而，在 PyTorch 中，我们使用梯度带（gradient tape）。我们记录操作发生时的情况，并在计算导数时向后重放它们。通过这种方式，框架不必为语言中的所有结构明确定义导数。

Autograd 如何工作¶

TorchScript 基础¶

现在让我们看看我们的运行示例，了解如何应用 TorchScript。

简而言之，TorchScript 提供了工具来捕获模型的定义，即使考虑到 PyTorch 灵活和动态的特性。让我们首先检查我们称之为 tracing 的方法。

Tracing `Modules`¶

class MyCell(torch.nn.Module):
    def __init__(self):
        super(MyCell, self).__init__()
        self.linear = torch.nn.Linear(4, 4)

    def forward(self, x, h):
        new_h = torch.tanh(self.linear(x) + h)
        return new_h, new_h

my_cell = MyCell()
x, h = torch.rand(3, 4), torch.rand(3, 4)
traced_cell = torch.jit.trace(my_cell, (x, h))
print(traced_cell)
traced_cell(x, h)

MyCell(
  original_name=MyCell
  (linear): Linear(original_name=Linear)
)

(tensor([[-0.2541,  0.2460,  0.2297,  0.1014],
        [-0.2329, -0.2911,  0.5641,  0.5015],
        [ 0.1688,  0.2252,  0.7251,  0.2530]], grad_fn=<TanhBackward0>), tensor([[-0.2541,  0.2460,  0.2297,  0.1014],
        [-0.2329, -0.2911,  0.5641,  0.5015],
        [ 0.1688,  0.2252,  0.7251,  0.2530]], grad_fn=<TanhBackward0>))

我们稍微回退了一下，使用了我们的 MyCell 类的第二个版本。像之前一样，我们实例化了它，但这次我们调用了 torch.jit.trace，传入了 Module，并传入了网络可能会看到的示例输入。

这到底做了什么？它调用了 Module，记录了 Module 运行时发生的操作，并创建了一个 torch.jit.ScriptModule 实例（TracedModule 是其一个实例）。

TorchScript 将其定义记录在中间表示（IR）中，在深度学习中通常称为图。我们可以使用 .graph 属性检查该图。

print(traced_cell.graph)

graph(%self.1 : __torch__.MyCell,
      %x : Float(3, 4, strides=[4, 1], requires_grad=0, device=cpu),
      %h : Float(3, 4, strides=[4, 1], requires_grad=0, device=cpu)):
  %linear : __torch__.torch.nn.modules.linear.Linear = prim::GetAttr[name="linear"](%self.1)
  %20 : Tensor = prim::CallMethod[name="forward"](%linear, %x)
  %11 : int = prim::Constant[value=1]() # /var/lib/workspace/beginner_source/Intro_to_TorchScript_tutorial.py:191:0
  %12 : Float(3, 4, strides=[4, 1], requires_grad=1, device=cpu) = aten::add(%20, %h, %11) # /var/lib/workspace/beginner_source/Intro_to_TorchScript_tutorial.py:191:0
  %13 : Float(3, 4, strides=[4, 1], requires_grad=1, device=cpu) = aten::tanh(%12) # /var/lib/workspace/beginner_source/Intro_to_TorchScript_tutorial.py:191:0
  %14 : (Float(3, 4, strides=[4, 1], requires_grad=1, device=cpu), Float(3, 4, strides=[4, 1], requires_grad=1, device=cpu)) = prim::TupleConstruct(%13, %13)
  return (%14)

然而，这是一个非常低级的表示，图中的大多数信息对最终用户没有用处。相反，我们可以使用 .code 属性给出代码的 Python 语法解释。

print(traced_cell.code)

def forward(self,
    x: Tensor,
    h: Tensor) -> Tuple[Tensor, Tensor]:
  linear = self.linear
  _0 = torch.tanh(torch.add((linear).forward(x, ), h))
  return (_0, _0)

那么我们为什么要这样做呢？有几个原因：

TorchScript 代码可以在其自己的解释器中调用，这基本上是一个受限的 Python 解释器。这个解释器不会获取全局解释器锁，因此可以在同一实例上同时处理许多请求。
这种格式允许我们将整个模型保存到磁盘，并将其加载到其他环境中，例如用非 Python 语言编写的服务器中。
TorchScript 提供了一种表示，我们可以在其上对代码进行编译器优化，以提供更高效的执行。
TorchScript 允许我们与许多后端/设备运行时进行接口，这些运行时需要比单个算子更广阔的程序视图。

我们可以看到，调用 traced_cell 产生的结果与 Python 模块相同。

print(my_cell(x, h))
print(traced_cell(x, h))

(tensor([[-0.2541,  0.2460,  0.2297,  0.1014],
        [-0.2329, -0.2911,  0.5641,  0.5015],
        [ 0.1688,  0.2252,  0.7251,  0.2530]], grad_fn=<TanhBackward0>), tensor([[-0.2541,  0.2460,  0.2297,  0.1014],
        [-0.2329, -0.2911,  0.5641,  0.5015],
        [ 0.1688,  0.2252,  0.7251,  0.2530]], grad_fn=<TanhBackward0>))
(tensor([[-0.2541,  0.2460,  0.2297,  0.1014],
        [-0.2329, -0.2911,  0.5641,  0.5015],
        [ 0.1688,  0.2252,  0.7251,  0.2530]], grad_fn=<TanhBackward0>), tensor([[-0.2541,  0.2460,  0.2297,  0.1014],
        [-0.2329, -0.2911,  0.5641,  0.5015],
        [ 0.1688,  0.2252,  0.7251,  0.2530]], grad_fn=<TanhBackward0>))

使用 Scripting 转换模块¶

我们使用模块的第二个版本而不是包含控制流的子模块的版本是有原因的。现在让我们来检查一下。

class MyDecisionGate(torch.nn.Module):
    def forward(self, x):
        if x.sum() > 0:
            return x
        else:
            return -x

class MyCell(torch.nn.Module):
    def __init__(self, dg):
        super(MyCell, self).__init__()
        self.dg = dg
        self.linear = torch.nn.Linear(4, 4)

    def forward(self, x, h):
        new_h = torch.tanh(self.dg(self.linear(x)) + h)
        return new_h, new_h

my_cell = MyCell(MyDecisionGate())
traced_cell = torch.jit.trace(my_cell, (x, h))

print(traced_cell.dg.code)
print(traced_cell.code)

/var/lib/workspace/beginner_source/Intro_to_TorchScript_tutorial.py:263: TracerWarning:

Converting a tensor to a Python boolean might cause the trace to be incorrect. We can't record the data flow of Python values, so this value will be treated as a constant in the future. This means that the trace might not generalize to other inputs!

def forward(self,
    argument_1: Tensor) -> NoneType:
  return None

def forward(self,
    x: Tensor,
    h: Tensor) -> Tuple[Tensor, Tensor]:
  dg = self.dg
  linear = self.linear
  _0 = (linear).forward(x, )
  _1 = (dg).forward(_0, )
  _2 = torch.tanh(torch.add(_0, h))
  return (_2, _2)

查看 .code 的输出，我们可以看到 if-else 分支无处可寻！为什么？Tracing 精确地执行了我们所说的操作：运行代码，记录发生的操作，并构建一个完全执行这些操作的 ScriptModule。遗憾的是，控制流等内容被抹去了。

我们如何在 TorchScript 中忠实地表示这个模块？我们提供了一个 script compiler，它直接分析你的 Python 源代码并将其转换为 TorchScript。让我们使用 script compiler 转换 MyDecisionGate。

scripted_gate = torch.jit.script(MyDecisionGate())

my_cell = MyCell(scripted_gate)
scripted_cell = torch.jit.script(my_cell)

print(scripted_gate.code)
print(scripted_cell.code)

def forward(self,
    x: Tensor) -> Tensor:
  if bool(torch.gt(torch.sum(x), 0)):
    _0 = x
  else:
    _0 = torch.neg(x)
  return _0

def forward(self,
    x: Tensor,
    h: Tensor) -> Tuple[Tensor, Tensor]:
  dg = self.dg
  linear = self.linear
  _0 = torch.add((dg).forward((linear).forward(x, ), ), h)
  new_h = torch.tanh(_0)
  return (new_h, new_h)

万岁！我们现在已经在 TorchScript 中忠实地捕获了程序的行为。现在让我们尝试运行程序。

# New inputs
x, h = torch.rand(3, 4), torch.rand(3, 4)
print(scripted_cell(x, h))

(tensor([[ 0.5679,  0.5762,  0.2506, -0.0734],
        [ 0.5228,  0.7122,  0.6985, -0.0656],
        [ 0.6187,  0.4487,  0.7456, -0.0238]], grad_fn=<TanhBackward0>), tensor([[ 0.5679,  0.5762,  0.2506, -0.0734],
        [ 0.5228,  0.7122,  0.6985, -0.0656],
        [ 0.6187,  0.4487,  0.7456, -0.0238]], grad_fn=<TanhBackward0>))

混合使用 Scripting 和 Tracing¶

某些情况下需要使用 tracing 而不是 scripting（例如，模块有许多基于我们不希望出现在 TorchScript 中的常量 Python 值做出的架构决策）。在这种情况下，scripting 可以与 tracing 组合：torch.jit.script 会内联 traced 模块的代码，而 tracing 会内联 scripted 模块的代码。

第一种情况的示例

class MyRNNLoop(torch.nn.Module):
    def __init__(self):
        super(MyRNNLoop, self).__init__()
        self.cell = torch.jit.trace(MyCell(scripted_gate), (x, h))

    def forward(self, xs):
        h, y = torch.zeros(3, 4), torch.zeros(3, 4)
        for i in range(xs.size(0)):
            y, h = self.cell(xs[i], h)
        return y, h

rnn_loop = torch.jit.script(MyRNNLoop())
print(rnn_loop.code)

def forward(self,
    xs: Tensor) -> Tuple[Tensor, Tensor]:
  h = torch.zeros([3, 4])
  y = torch.zeros([3, 4])
  y0 = y
  h0 = h
  for i in range(torch.size(xs, 0)):
    cell = self.cell
    _0 = (cell).forward(torch.select(xs, 0, i), h0, )
    y1, h1, = _0
    y0, h0 = y1, h1
  return (y0, h0)

第二种情况的示例

class WrapRNN(torch.nn.Module):
    def __init__(self):
        super(WrapRNN, self).__init__()
        self.loop = torch.jit.script(MyRNNLoop())

    def forward(self, xs):
        y, h = self.loop(xs)
        return torch.relu(y)

traced = torch.jit.trace(WrapRNN(), (torch.rand(10, 3, 4)))
print(traced.code)

def forward(self,
    xs: Tensor) -> Tensor:
  loop = self.loop
  _0, y, = (loop).forward(xs, )
  return torch.relu(y)

通过这种方式，可以在需要时单独使用 scripting 和 tracing，也可以将它们结合使用。

保存和加载模型¶

我们提供了 API，用于以归档格式将 TorchScript 模块保存到磁盘或从磁盘加载。这种格式包括代码、参数、属性和调试信息，这意味着该归档文件是模型的一个独立表示，可以在完全独立的进程中加载。让我们保存和加载我们的包装 RNN 模块。

traced.save('wrapped_rnn.pt')

loaded = torch.jit.load('wrapped_rnn.pt')

print(loaded)
print(loaded.code)

RecursiveScriptModule(
  original_name=WrapRNN
  (loop): RecursiveScriptModule(
    original_name=MyRNNLoop
    (cell): RecursiveScriptModule(
      original_name=MyCell
      (dg): RecursiveScriptModule(original_name=MyDecisionGate)
      (linear): RecursiveScriptModule(original_name=Linear)
    )
  )
)
def forward(self,
    xs: Tensor) -> Tensor:
  loop = self.loop
  _0, y, = (loop).forward(xs, )
  return torch.relu(y)

如您所见，序列化保留了模块层次结构和我们一直在检查的代码。该模型也可以加载，例如，到 C++ 中进行无需 Python 的执行。

进一步阅读¶

我们已经完成了教程！有关更详细的演示，请查看使用 TorchScript 转换机器翻译模型的 NeurIPS 演示：https://colab.research.google.com/drive/1HiICg6jRkBnr5hvK2-VnMi88Vi9pUzEJ

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

图库由 Sphinx-Gallery 生成

TorchScript 简介¶

PyTorch 模型编写基础¶

TorchScript 基础¶

Tracing `Modules`¶

使用 Scripting 转换模块¶

混合使用 Scripting 和 Tracing¶

保存和加载模型¶

进一步阅读¶

文档

教程

资源

TorchScript 简介¶

PyTorch 模型编写基础¶

TorchScript 基础¶

Tracing Modules¶

使用 Scripting 转换模块¶

混合使用 Scripting 和 Tracing¶

保存和加载模型¶

进一步阅读¶

文档

教程

资源

Tracing `Modules`¶