torch.jit.script

torch.jit.script(obj, optimize=None, _frames_up=0, _rcb=None, example_inputs=None)

将函数脚本化。

使用脚本或 nn.Module 可以检查源代码，使用 TorchScript 编译器将其编译为 TorchScript 代码，并返回 ScriptModule 或 ScriptFunction 。TorchScript 本身是 Python 语言的一个子集，因此并非 Python 中的所有功能都可用，但我们提供了足够的函数来在张量上计算和控制依赖操作。有关完整指南，请参阅 TorchScript 语言参考。

脚本化字典或列表会将内部数据复制到 TorchScript 实例中，从而可以在 Python 和 TorchScript 之间通过引用传递，且无复制开销。

torch.jit.script 可以用作模块、函数、字典和列表的函数。

也可以用作 TorchScript 类和函数的装饰器 @torch.jit.script 。

参数:

• obj (Callable, class, or nn.Module) – 要编译的 nn.Module ，函数、类类型、字典或列表。

• example_inputs (Union[List[Tuple], Dict[Callable, List[Tuple]], None]) – 提供示例输入以注释函数或 nn.Module 的参数。

返回值:

如果 obj 是 nn.Module ， script 返回一个 ScriptModule 对象。返回的 ScriptModule 将具有与原始 nn.Module 相同的子模块和参数集。如果 obj 是一个独立函数，则返回 ScriptFunction 。如果 obj 是 dict ，则 script 返回一个 torch._C.ScriptDict 实例。如果 obj 是 list ，则 script 返回一个 torch._C.ScriptList 实例。

函数脚本化

@torch.jit.script 装饰器将构建一个 ScriptFunction ，通过编译函数体。

示例（编写函数）：

import torch

@torch.jit.script
def foo(x, y):
    if x.max() > y.max():
        r = x
    else:
        r = y
    return r

print(type(foo))  # torch.jit.ScriptFunction

# See the compiled graph as Python code
print(foo.code)

# Call the function using the TorchScript interpreter
foo(torch.ones(2, 2), torch.ones(2, 2))

**使用示例输入编写函数

示例输入可用于注释函数参数。

示例（在脚本编写前注释函数）：

import torch

def test_sum(a, b):
    return a + b

# Annotate the arguments to be int
scripted_fn = torch.jit.script(test_sum, example_inputs=[(3, 4)])

print(type(scripted_fn))  # torch.jit.ScriptFunction

# See the compiled graph as Python code
print(scripted_fn.code)

# Call the function using the TorchScript interpreter
scripted_fn(20, 100)

脚本编写 nn.Module

脚本编写 nn.Module 默认情况下将编译 forward 方法，并递归编译由 forward 调用的任何方法、子模块和函数。如果 nn.Module 只使用 TorchScript 支持的功能，则不需要对原始模块代码进行任何更改。 script 将构建具有原始模块的属性、参数和方法副本的 ScriptModule 。

示例（使用 Parameter 脚本编写简单模块）：

import torch

class MyModule(torch.nn.Module):
    def __init__(self, N, M):
        super().__init__()
        # This parameter will be copied to the new ScriptModule
        self.weight = torch.nn.Parameter(torch.rand(N, M))

        # When this submodule is used, it will be compiled
        self.linear = torch.nn.Linear(N, M)

    def forward(self, input):
        output = self.weight.mv(input)

        # This calls the `forward` method of the `nn.Linear` module, which will
        # cause the `self.linear` submodule to be compiled to a `ScriptModule` here
        output = self.linear(output)
        return output

scripted_module = torch.jit.script(MyModule(2, 3))

沉浸式翻译示例（使用追踪子模块编写模块）：

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

class MyModule(nn.Module):
    def __init__(self) -> None:
        super().__init__()
        # torch.jit.trace produces a ScriptModule's conv1 and conv2
        self.conv1 = torch.jit.trace(nn.Conv2d(1, 20, 5), torch.rand(1, 1, 16, 16))
        self.conv2 = torch.jit.trace(nn.Conv2d(20, 20, 5), torch.rand(1, 20, 16, 16))

    def forward(self, input):
        input = F.relu(self.conv1(input))
        input = F.relu(self.conv2(input))
        return input

scripted_module = torch.jit.script(MyModule())

要编译除 forward 之外的方法（以及它调用的任何内容），请在该方法上添加 @torch.jit.export 装饰器。要取消编译，请使用 @torch.jit.ignore 或 @torch.jit.unused 。

模块中导出并忽略的方法示例：

import torch
import torch.nn as nn


class MyModule(nn.Module):
    def __init__(self) -> None:
        super().__init__()

    @torch.jit.export
    def some_entry_point(self, input):
        return input + 10

    @torch.jit.ignore
    def python_only_fn(self, input):
        # This function won't be compiled, so any
        # Python APIs can be used
        import pdb

        pdb.set_trace()

    def forward(self, input):
        if self.training:
            self.python_only_fn(input)
        return input * 99


scripted_module = torch.jit.script(MyModule())
print(scripted_module.some_entry_point(torch.randn(2, 2)))
print(scripted_module(torch.randn(2, 2)))

使用示例输入注释 nn.Module 的前向示例：

import torch
import torch.nn as nn
from typing import NamedTuple

class MyModule(NamedTuple):
result: List[int]

class TestNNModule(torch.nn.Module):
    def forward(self, a) -> MyModule:
        result = MyModule(result=a)
        return result

pdt_model = TestNNModule()

# Runs the pdt_model in eager model with the inputs provided and annotates the arguments of forward
scripted_model = torch.jit.script(pdt_model, example_inputs={pdt_model: [([10, 20, ], ), ], })

# Run the scripted_model with actual inputs
print(scripted_model([20]))