自定义后端¶

概述¶

torch.compile 提供了一种简单的方法，使用户能够定义自定义后端。

一个后端函数具有以下契约 (gm: torch.fx.GraphModule, example_inputs: List[torch.Tensor]) -> Callable。

后端函数可以由TorchDynamo调用，TorchDynamo是torch.compile的图追踪组件，在追踪FX图之后，预期返回一个与追踪的FX图等效的编译函数。返回的可调用对象应具有与原始torch.fx.GraphModule 传递给后端的forward函数相同的契约： (*args: torch.Tensor) -> List[torch.Tensor]。

为了让 TorchDynamo 调用您的后端，请将您的后端函数作为 backend 关键字参数传递给 torch.compile。例如，

import torch

def my_custom_backend(gm, example_inputs):
    return gm.forward

def f(...):
    ...

f_opt = torch.compile(f, backend=my_custom_backend)

@torch.compile(backend=my_custom_backend)
def g(...):
    ...

更多示例请参见下方。

注册自定义后端¶

您可以使用 register_backend 装饰器注册您的后端，例如，

from torch._dynamo import register_backend

@register_backend
def my_compiler(gm, example_inputs):
    ...

除了 register_backend 装饰器外，如果你的后端在另一个 Python 包中，你也可以通过 Python 包的入口点注册你的后端，这为包提供了一种为另一个包注册插件的方式。

提示

您可以在python 打包文档中了解更多关于entry_points的信息。

要通过 entry_points 注册您的后端，您可以将后端函数添加到包的 setup.py 文件中的 torch_dynamo_backends 入口点组中，如下所示：

...
setup(
    ...
    'torch_dynamo_backends': [
        'my_compiler = your_module.submodule:my_compiler',
    ]
    ...
)

请将my_compiler之前的部分替换为您的后端名称，并将=之后的部分替换为您的后端模块和函数名称。安装包后，入口点将添加到您的Python环境中。当您调用torch.compile(model, backend="my_compiler")时，PyTorch会首先搜索已通过register_backend注册的后端名为my_compiler的后端。如果未找到，它将继续在通过entry_points注册的所有后端中搜索。

注册有两个目的：

你可以传递一个包含你的后端函数名称的字符串给 torch.compile 而不是函数本身，例如，torch.compile(model, backend="my_compiler")。
在使用minifier时是必需的。minifier生成的任何代码都必须调用注册您的后端函数的代码，通常通过import语句来实现。

AOTAutograd 之后的自定义后端¶

可以定义自定义后端，这些后端由AOTAutograd调用，而不是TorchDynamo。这主要有两个原因：

用户可以定义支持模型训练的后端，因为AOTAutograd可以为编译生成反向图。
AOTAutograd 生成由规范 Aten 操作组成的 FX 图。因此，自定义后端只需要支持规范 Aten 操作集，这比整个 torch/Aten 操作集要小得多。

将您的后端与 torch._dynamo.backends.common.aot_autograd 包装，并像之前一样使用 torch.compile 和 backend 关键字参数。由 aot_autograd 包装的后端函数应具有与之前相同的约定。

后端函数通过 fw_compiler（前向编译器）或 bw_compiler（后向编译器）kwargs 传递给 aot_autograd。如果未指定 bw_compiler，则后向编译函数默认为前向编译函数。

一个需要注意的是，AOTAutograd 要求后端返回的编译函数必须是“装箱”的。这可以通过使用 functorch.compile.make_boxed_func 包装编译函数来实现。

例如，

from torch._dynamo.backends.common import aot_autograd
from functorch.compile import make_boxed_func

def my_compiler(gm, example_inputs):
    return make_boxed_func(gm.forward)

my_backend = aot_autograd(fw_compiler=my_compiler)  # 反向传播编译器=my_compiler

model_opt = torch.compile(model, backend=my_backend)

示例¶

调试后端¶

如果你想更好地理解编译过程中发生了什么，你可以创建一个自定义编译器，在本节中称为后端，它将打印从Dynamo的字节码分析中提取的GraphModule，并返回一个可调用的forward()。

例如：

from typing import List
import torch
def my_compiler(gm: torch.fx.GraphModule, example_inputs: List[torch.Tensor]):
    print("my_compiler() called with FX graph:")
    gm.graph.print_tabular()
    return gm.forward  # 返回一个可调用的Python对象
@torch.compile(backend=my_compiler)
def fn(x, y):
    a = torch.cos(x)
    b = torch.sin(y)
    return a + b
fn(torch.randn(10), torch.randn(10))

运行上述示例会产生以下输出：

my_compiler() 被调用 使用 FX 图:
操作码         名称    目标                                                  参数        关键字参数
-------------  ------  ------------------------------------------------------  ----------  --------
占位符    x       x                                                       ()          {}
占位符    y       y                                                       ()          {}
调用函数  cos     <built-in method cos of type object at 0x7f1a894649a8>  (x,)        {}
调用函数  sin     <built-in method sin of type object at 0x7f1a894649a8>  (y,)        {}
调用函数  add     <built-in function add>                                 (cos, sin)  {}
输出         输出  输出                                                  ((add,),)   {}

这同样适用于torch.nn.Module，如下所示：

from typing import List
import torch
def my_compiler(gm: torch.fx.GraphModule, example_inputs: List[torch.Tensor]):
    print("my_compiler() 被调用，传入的 FX 图为：")
    gm.graph.print_tabular()
    return gm.forward  # 返回一个 Python 可调用对象
class MockModule(torch.nn.Module):
    def __init__(self):
        super().__init__()
        self.relu = torch.nn.ReLU()
    def forward(self, x):
        return self.relu(torch.cos(x))
mod = MockModule()
optimized_mod = torch.compile(mod, backend=my_compiler)
optimized_mod(torch.randn(10))

让我们再来看一个关于控制流的例子：

from typing import List
import torch
def my_compiler(gm: torch.fx.GraphModule, example_inputs: List[torch.Tensor]):
    print("my_compiler() called with FX graph:")
    gm.graph.print_tabular()
    return gm.forward  # 返回一个Python可调用对象
@torch.compile(backend=my_compiler)
def toy_example(a, b):
    x = a / (torch.abs(a) + 1)
    if b.sum() < 0:
        b = b * -1
    return x * b
for _ in range(100):
    toy_example(torch.randn(10), torch.randn(10))

运行此示例会产生以下输出：

my_compiler() called with FX graph:
opcode         name     target                                                  args              kwargs
-------------  -------  ------------------------------------------------------  ----------------  --------
placeholder    a        a                                                       ()                {}
placeholder    b        b                                                       ()                {}
call_function  abs_1    <built-in method abs of type object at 0x7f8d259298a0>  (a,)              {}
call_function  add      <built-in function add>                                 (abs_1, 1)        {}
call_function  truediv  <built-in function truediv>                             (a, add)          {}
call_method    sum_1    sum                                                     (b,)              {}
call_function  lt       <built-in function lt>                                  (sum_1, 0)        {}
output         output   output                                                  ((truediv, lt),)  {}

my_compiler() called with FX graph:
opcode         name    target                   args         kwargs
-------------  ------  -----------------------  -----------  --------
placeholder    b       b                        ()           {}
placeholder    x       x                        ()           {}
call_function  mul     <built-in function mul>  (b, -1)      {}
call_function  mul_1   <built-in function mul>  (x, mul)     {}
output         output  output                   ((mul_1,),)  {}

my_compiler() called with FX graph:
opcode         name    target                   args       kwargs
-------------  ------  -----------------------  ---------  --------
placeholder    b       b                        ()         {}
placeholder    x       x                        ()         {}
call_function  mul     <built-in function mul>  (x, b)     {}
output         output  output                   ((mul,),)  {}

The order of the last two graphs is nondeterministic depending
on which one is encountered first by the just-in-time compiler.

快速后端¶

集成一个提供卓越性能的自定义后端也非常简单，我们将集成一个真实的后端，并使用optimize_for_inference进行优化：

def optimize_for_inference_compiler(gm: torch.fx.GraphModule, example_inputs: List[torch.Tensor]):
    scripted = torch.jit.script(gm)
    return torch.jit.optimize_for_inference(scripted)

然后你应该能够使用以下方法优化任何现有代码：

@torch.compile(backend=optimize_for_inference_compiler)
def code_to_accelerate():
    ...

可组合的后端¶

TorchDynamo 包含许多后端，可以通过以下代码列出： torch._dynamo.list_backends()。你可以将这些后端组合在一起，使用以下代码：

from torch._dynamo import lookup_backend
def my_compiler(gm: torch.fx.GraphModule, example_inputs: List[torch.Tensor]):
    try:
        trt_compiled = lookup_backend("tensorrt")(gm, example_inputs)
        if trt_compiled is not None:
            return trt_compiled
    except Exception:
        pass
    # 第一个后端失败，尝试其他...
    try:
        inductor_compiled = lookup_backend("inductor")(gm, example_inputs)
        if inductor_compiled is not None:
            return inductor_compiled
    except Exception:
        pass
    return gm.forward