自定义后端¶
概述¶
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 调用您的后端，请在 torch.compile 中将您的后端函数作为 backend kwarg 传递。例如，
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 调用的自定义后端。这对于以下 2 个主要原因很有用
用户可以定义支持模型训练的后端，因为 AOTAutograd 可以生成用于编译的后向图。
AOTAutograd 生成由 核心 Aten 运算符 组成的 FX 图形。因此，自定义后端只需要支持核心 Aten 运算符集，这比整个 torch/Aten 运算符集小得多。
将您的后端与 torch._dynamo.backends.common.aot_autograd 包装，并像以前一样使用带有 backend kwarg 的 torch.compile。由 aot_autograd 包装的后端函数应具有与以前相同的约定。
后端函数通过 fw_compiler（前向编译器）或 bw_compiler（后向编译器）kwargs 传递给 aot_autograd。如果未指定 bw_compiler，则后向编译函数默认为前向编译函数。
一个需要注意的地方是，AOTAutograd 要求后端返回的编译函数是“boxed”的。这可以通过使用 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) # bw_compiler=my_compiler
model_opt = torch.compile(model, backend=my_backend)
示例¶
调试后端¶
如果您想更好地了解编译期间发生的情况，您可以创建一个自定义编译器，在本节中称为后端，它将漂亮地打印从 Dynamo 的字节码分析中提取的 fx 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 # return a python callable
@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() called with FX graph:
opcode name target args kwargs
------------- ------ ------------------------------------------------------ ---------- --------
placeholder x x () {}
placeholder y y () {}
call_function cos <built-in method cos of type object at 0x7f1a894649a8> (x,) {}
call_function sin <built-in method sin of type object at 0x7f1a894649a8> (y,) {}
call_function add <built-in function add> (cos, sin) {}
output output output ((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() called with FX graph:")
gm.graph.print_tabular()
return gm.forward # return a python callable
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 # return a python callable
@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
# first backend failed, try something else...
try:
inductor_compiled = lookup_backend("inductor")(gm, example_inputs)
if inductor_compiled is not None:
return inductor_compiled
except Exception:
pass
return gm.forward
