注意
点击 这里 下载完整的示例代码
自定义Python操作符
创建于：2024年6月18日 | 最后更新：2025年1月2日 | 最后验证：2024年11月5日
如何将用Python编写的自定义操作符与PyTorch集成
如何使用
torch.library.opcheck测试自定义运算符
PyTorch 2.4 或更高版本
PyTorch 提供了一个庞大的运算符库，这些运算符可以作用于张量（例如 torch.add, torch.sum 等）。然而，您可能希望使用一个新的自定义运算符与 PyTorch 一起使用，这个运算符可能是由第三方库编写的。本教程展示了如何包装 Python 函数，使其表现得像 PyTorch 原生运算符。您可能希望在 PyTorch 中创建自定义运算符的原因包括：
将任意Python函数视为相对于
torch.compile的不透明可调用对象（即防止torch.compile追踪到该函数内部）。向任意Python函数添加训练支持
请注意，如果您的操作可以表示为现有PyTorch操作符的组合，那么通常不需要使用自定义操作符API——所有功能（例如torch.compile，训练支持）应该都能正常工作。
示例：将PIL的裁剪功能封装为自定义操作符
假设我们正在使用PIL的crop操作。
import torch
from torchvision.transforms.functional import to_pil_image, pil_to_tensor
import PIL
import IPython
import matplotlib.pyplot as plt
def crop(pic, box):
img = to_pil_image(pic.cpu())
cropped_img = img.crop(box)
return pil_to_tensor(cropped_img).to(pic.device) / 255.
def display(img):
plt.imshow(img.numpy().transpose((1, 2, 0)))
img = torch.ones(3, 64, 64)
img *= torch.linspace(0, 1, steps=64) * torch.linspace(0, 1, steps=64).unsqueeze(-1)
display(img)
cropped_img = crop(img, (10, 10, 50, 50))
display(cropped_img)
crop 在 torch.compile 中并未得到有效处理：torch.compile 会在无法处理的函数上引发
“graph break”，而 graph break 对性能不利。
以下代码通过引发错误来演示这一点
（如果发生 graph break，torch.compile 与 fullgraph=True 会引发错误）。
为了将crop黑盒化以便与torch.compile一起使用，我们需要做两件事：
将函数包装成PyTorch自定义操作符。
添加一个“
FakeTensor内核”（也称为“元内核”）到操作符中。 给定一些FakeTensors输入（没有存储的虚拟张量）， 此函数应返回您选择的具有正确张量元数据（形状/步幅/dtype/设备）的虚拟张量。
from typing import Sequence
# Use torch.library.custom_op to define a new custom operator.
# If your operator mutates any input Tensors, their names must be specified
# in the ``mutates_args`` argument.
@torch.library.custom_op("mylib::crop", mutates_args=())
def crop(pic: torch.Tensor, box: Sequence[int]) -> torch.Tensor:
img = to_pil_image(pic.cpu())
cropped_img = img.crop(box)
return (pil_to_tensor(cropped_img) / 255.).to(pic.device, pic.dtype)
# Use register_fake to add a ``FakeTensor`` kernel for the operator
@crop.register_fake
def _(pic, box):
channels = pic.shape[0]
x0, y0, x1, y1 = box
return pic.new_empty(channels, y1 - y0, x1 - x0)
在此之后，crop 现在可以在没有图形中断的情况下工作：
/usr/local/lib/python3.10/dist-packages/onnxscript/converter.py:820: FutureWarning:
'onnxscript.values.Op.param_schemas' is deprecated in version 0.1 and will be removed in the future. Please use '.op_signature' instead.
/usr/local/lib/python3.10/dist-packages/onnxscript/converter.py:820: FutureWarning:
'onnxscript.values.OnnxFunction.param_schemas' is deprecated in version 0.1 and will be removed in the future. Please use '.op_signature' instead.
display(cropped_img)
为作物添加训练支持
使用torch.library.register_autograd为操作符添加训练支持。
优先使用此方法，而不是直接使用torch.autograd.Function；某些组合
autograd.Function与PyTorch操作符注册API的组合可能会导致（并且
已经导致）与torch.compile组合时出现静默错误。
如果您不需要训练支持，则无需使用
torch.library.register_autograd。
如果您最终使用没有自动梯度注册的custom_op进行训练，我们将引发错误消息。
crop 的梯度公式本质上是 PIL.paste（我们将推导留给读者作为练习）。首先，我们将 paste 包装成一个自定义操作符：
@torch.library.custom_op("mylib::paste", mutates_args=())
def paste(im1: torch.Tensor, im2: torch.Tensor, coord: Sequence[int]) -> torch.Tensor:
assert im1.device == im2.device
assert im1.dtype == im2.dtype
im1_pil = to_pil_image(im1.cpu())
im2_pil = to_pil_image(im2.cpu())
PIL.Image.Image.paste(im1_pil, im2_pil, coord)
return (pil_to_tensor(im1_pil) / 255.).to(im1.device, im1.dtype)
@paste.register_fake
def _(im1, im2, coord):
assert im1.device == im2.device
assert im1.dtype == im2.dtype
return torch.empty_like(im1)
现在让我们使用register_autograd来指定crop的梯度公式：
def backward(ctx, grad_output):
grad_input = grad_output.new_zeros(ctx.pic_shape)
grad_input = paste(grad_input, grad_output, ctx.coords)
return grad_input, None
def setup_context(ctx, inputs, output):
pic, box = inputs
ctx.coords = box[:2]
ctx.pic_shape = pic.shape
crop.register_autograd(backward, setup_context=setup_context)
请注意，backward 必须是 PyTorch 能够理解的运算符的组合，这就是为什么我们将 paste 包装成一个自定义运算符，而不是直接使用 PIL 的 paste。
这是正确的梯度，裁剪区域为1（白色），未使用区域为0（黑色）。
测试Python自定义操作符
使用torch.library.opcheck来测试自定义操作符是否正确注册。这并不测试梯度在数学上是否正确；请为此编写单独的测试（手动测试或torch.autograd.gradcheck）。
要使用opcheck，请传递一组示例输入进行测试。如果您的运算符支持训练，则示例应包括需要梯度的张量。如果您的运算符支持多个设备，则示例应包括来自每个设备的张量。
examples = [
[torch.randn(3, 64, 64), [0, 0, 10, 10]],
[torch.randn(3, 91, 91, requires_grad=True), [10, 0, 20, 10]],
[torch.randn(3, 60, 60, dtype=torch.double), [3, 4, 32, 20]],
[torch.randn(3, 512, 512, requires_grad=True, dtype=torch.double), [3, 4, 32, 45]],
]
for example in examples:
torch.library.opcheck(crop, example)
可变的Python自定义操作符
你也可以将一个改变其输入的Python函数封装成一个自定义操作符。
改变输入的函数很常见，因为许多底层内核就是这样编写的；例如，一个计算sin的内核可能会接收输入和一个输出张量，并将input.sin()写入输出张量。
我们将使用numpy.sin来演示一个可变的Python自定义操作符的示例。
import numpy as np
@torch.library.custom_op("mylib::numpy_sin", mutates_args={"output"}, device_types="cpu")
def numpy_sin(input: torch.Tensor, output: torch.Tensor) -> None:
assert input.device == output.device
assert input.device.type == "cpu"
input_np = input.numpy()
output_np = output.numpy()
np.sin(input_np, out=output_np)
因为操作符不返回任何内容，所以不需要注册一个FakeTensor内核（元内核）来使其与torch.compile一起工作。
@torch.compile(fullgraph=True)
def f(x):
out = torch.empty(3)
numpy_sin(x, out)
return out
x = torch.randn(3)
y = f(x)
assert torch.allclose(y, x.sin())
这里有一个opcheck运行结果告诉我们，我们确实正确地注册了操作符。
例如，如果我们忘记将输出添加到mutates_args，opcheck将会报错。
example_inputs = [
[torch.randn(3), torch.empty(3)],
[torch.randn(0, 3), torch.empty(0, 3)],
[torch.randn(1, 2, 3, 4, dtype=torch.double), torch.empty(1, 2, 3, 4, dtype=torch.double)],
]
for example in example_inputs:
torch.library.opcheck(numpy_sin, example)
