扩展 PyTorch#
创建日期：2017 年 1 月 16 日 | 最后更新日期：2025 年 5 月 7 日
在本说明中，我们将介绍扩展 torch.nn、torch.autograd、torch 以及编写自定义 C++ 扩展的方法。
添加新运算符#
PyTorch 提供了一个庞大的运算符库，可用于张量（例如 torch.add()、torch.sum() 等）。但是，您可能希望将新的自定义操作引入 PyTorch，并使其行为类似于 PyTorch 的内置运算符。为此，您必须通过 Python torch.library 或 C++ TORCH_LIBRARY API 向 PyTorch 注册自定义操作。
请参阅 PyTorch 自定义运算符着陆页 了解更多详情。
扩展 torch.autograd#
将操作添加到 autograd 需要为每个操作实现一个新的 Function 子类。回想一下，函数是 autograd 用来编码操作历史并计算梯度的内容。
本文档的第一部分侧重于反向模式 AD，因为它是最广泛使用的功能。最后一部分讨论了正向模式 AD 的扩展。
何时使用#
一般来说，如果您想在模型中执行不可微分的计算或依赖非 PyTorch 库（例如 NumPy），但仍希望您的操作能够与其他操作链式连接并与 autograd 引擎一起工作，则可以实现自定义函数。
在某些情况下，自定义函数还可以用于提高性能和内存使用：如果您使用 C++ 扩展 实现前向和反向传递，您可以将它们包装在 Function 中以与 autograd 引擎接口。如果您想减少为反向传递保存的缓冲区数量，自定义函数可以用于将操作组合在一起。
何时不使用#
如果您已经可以使用 PyTorch 的内置操作来编写您的函数，那么它的反向图（很可能）已经能够被 autograd 记录下来。在这种情况下，您不需要自己实现反向函数。考虑使用普通的 Python 函数。
如果您需要维护状态，即可训练参数，您应该（也）使用自定义模块。有关扩展 torch.nn 的更多信息，请参阅以下部分。
如何使用#
请按照以下步骤操作： 1. 子类化 Function 并实现 forward()、（可选）setup_context() 和 backward() 方法。 2. 在 ctx 参数上调用适当的方法。 3. 声明您的函数是否支持 双反向。 4. 使用 gradcheck 验证您的梯度是否正确。
步骤 1： 子类化 Function 后，您需要定义 3 个方法
forward()是执行操作的代码。它可以接受任意数量的参数，如果指定默认值，其中一些可以是可选的。此处接受所有类型的 Python 对象。Tensor参数（即requires_grad=True）在调用之前将被转换为不跟踪历史的参数，并且它们的使用将被注册到图中。请注意，此逻辑不会遍历列表/字典/任何其他数据结构，只会考虑作为调用直接参数的张量。您可以返回单个Tensor输出，或者如果有多个输出，则返回张量的tuple。此外，请参阅Function的文档，以找到只能从forward()调用的有用方法的描述。setup_context()（可选）。可以编写一个接受ctx对象的“组合”forward()，或者（从 PyTorch 2.0 开始）一个不接受ctx的单独forward()和一个setup_context()方法，其中进行ctx修改。forward()应该进行计算，而setup_context()应该只负责ctx修改（不进行任何计算）。一般来说，单独的forward()和setup_context()更接近 PyTorch 原生操作的工作方式，因此与各种 PyTorch 子系统更具可组合性。有关更多详细信息，请参阅 组合或分离的 forward() 和 setup_context()。backward()（或vjp()）定义了梯度公式。它将被赋予与输出数量相同的Tensor参数，每个参数表示相对于该输出的梯度。重要的是**永远不要就地修改**这些参数。它应该返回与输入数量相同的张量，每个张量包含其对应输入的梯度。如果您的输入不需要梯度（needs_input_grad是一个布尔值元组，指示每个输入是否需要梯度计算），或者是非Tensor对象，您可以返回python:None。此外，如果您对forward()有可选参数，则可以返回比输入更多的梯度，只要它们都是None。
步骤 2： 您有责任正确使用 ctx 中的函数，以确保新的 Function 与 autograd 引擎正常工作。
save_for_backward()应该用于保存反向传递所需的任何张量（而不是直接在ctx上）。您不能将save_for_backward用于非张量；您应该直接将它们存储在ctx上。通过
save_for_backward保存张量：1. 允许 autograd 引擎在autograd.Function的反向计算完成后立即清除它们。（如果张量直接存储在ctx上，它将不必要地在 autograd 图的生命周期内保持活动状态——通常直到迭代结束。）2. 有助于避免某些引用循环（例如，因为autograd.Function本身的张量输出保留对 ctx 的引用）。3. 对于激活检查点和卸载等依赖于torch.autograd.graph.saved_tensors_hooks的功能至关重要。如果既不是输入也不是输出的张量被保存用于反向传播，您的
Function可能不支持双反向传播（参见步骤 3）。mark_dirty()必须用于标记任何被前向函数就地修改的输入。mark_non_differentiable()必须用于告知引擎某个输出是否不可微分。默认情况下，所有可微分类型的输出张量都将被设置为需要梯度。不可微分类型（即整数类型）的张量永远不会被标记为需要梯度。set_materialize_grads()可用于告知 autograd 引擎在输出不依赖于输入的情况下优化梯度计算，方法是不具化传递给反向函数的梯度张量。也就是说，如果设置为 False，Python 中的 None 对象或 C++ 中的“未定义张量”（x.defined() 为 False 的张量 x）在调用反向之前不会转换为填充零的张量，因此您的代码需要像处理填充零的张量一样处理这些对象。此设置的默认值为 True。
步骤 3： 如果您的 Function 不支持双反向传播，您应该通过使用 once_differentiable() 装饰器明确声明。使用此装饰器，尝试通过您的函数执行双反向传播将产生错误。有关双反向传播的更多信息，请参阅我们的双反向传播教程。
步骤 4： 建议您使用 torch.autograd.gradcheck() 来检查您的反向函数是否通过计算雅可比矩阵并将其值与使用有限差分数值计算的雅可比矩阵逐元素比较来正确计算前向函数的梯度。
示例#
您可以在下面找到 Linear 函数的代码，并附有额外的注释
# Inherit from Function
class LinearFunction(Function):
# Note that forward, setup_context, and backward are @staticmethods
@staticmethod
def forward(input, weight, bias):
output = input.mm(weight.t())
if bias is not None:
output += bias.unsqueeze(0).expand_as(output)
return output
@staticmethod
# inputs is a Tuple of all of the inputs passed to forward.
# output is the output of the forward().
def setup_context(ctx, inputs, output):
input, weight, bias = inputs
ctx.save_for_backward(input, weight, bias)
# This function has only a single output, so it gets only one gradient
@staticmethod
def backward(ctx, grad_output):
# This is a pattern that is very convenient - at the top of backward
# unpack saved_tensors and initialize all gradients w.r.t. inputs to
# None. Thanks to the fact that additional trailing Nones are
# ignored, the return statement is simple even when the function has
# optional inputs.
input, weight, bias = ctx.saved_tensors
grad_input = grad_weight = grad_bias = None
# These needs_input_grad checks are optional and there only to
# improve efficiency. If you want to make your code simpler, you can
# skip them. Returning gradients for inputs that don't require it is
# not an error.
if ctx.needs_input_grad[0]:
grad_input = grad_output.mm(weight)
if ctx.needs_input_grad[1]:
grad_weight = grad_output.t().mm(input)
if bias is not None and ctx.needs_input_grad[2]:
grad_bias = grad_output.sum(0)
return grad_input, grad_weight, grad_bias
现在，为了更方便地使用这些自定义操作，我们建议要么为它们创建别名，要么将它们包装在一个函数中。包装在一个函数中可以让我们支持默认参数和关键字参数
# Option 1: alias
linear = LinearFunction.apply
# Option 2: wrap in a function, to support default args and keyword args.
def linear(input, weight, bias=None):
return LinearFunction.apply(input, weight, bias)
这里，我们给出一个以非张量参数参数化的函数的额外示例
class MulConstant(Function):
@staticmethod
def forward(tensor, constant):
return tensor * constant
@staticmethod
def setup_context(ctx, inputs, output):
# ctx is a context object that can be used to stash information
# for backward computation
tensor, constant = inputs
ctx.constant = constant
@staticmethod
def backward(ctx, grad_output):
# We return as many input gradients as there were arguments.
# Gradients of non-Tensor arguments to forward must be None.
return grad_output * ctx.constant, None
在这里，我们通过调用 set_materialize_grads(False) 来优化上述示例
class MulConstant(Function):
@staticmethod
def forward(tensor, constant):
return tensor * constant
@staticmethod
def setup_context(ctx, inputs, output):
tensor, constant = inputs
ctx.set_materialize_grads(False)
ctx.constant = constant
@staticmethod
def backward(ctx, grad_output):
# Here we must handle None grad_output tensor. In this case we
# can skip unnecessary computations and just return None.
if grad_output is None:
return None, None
# We return as many input gradients as there were arguments.
# Gradients of non-Tensor arguments to forward must be None.
return grad_output * ctx.constant, None
如果您需要保存 forward() 中计算的任何“中间”张量，它们要么必须作为输出返回，要么将 forward 和 setup_context() 组合（参见 组合或分离的 forward() 和 setup_context()）。请注意，这意味着如果您希望梯度流经这些中间值，您需要为它们定义梯度公式（另请参见 双反向教程）
class MyCube(torch.autograd.Function):
@staticmethod
def forward(x):
# We wish to save dx for backward. In order to do so, it must
# be returned as an output.
dx = 3 * x ** 2
result = x ** 3
return result, dx
@staticmethod
def setup_context(ctx, inputs, output):
x, = inputs
result, dx = output
ctx.save_for_backward(x, dx)
@staticmethod
def backward(ctx, grad_output, grad_dx):
x, dx = ctx.saved_tensors
# In order for the autograd.Function to work with higher-order
# gradients, we must add the gradient contribution of `dx`,
# which is grad_dx * 6 * x.
result = grad_output * dx + grad_dx * 6 * x
return result
# Wrap MyCube in a function so that it is clearer what the output is
def my_cube(x):
result, dx = MyCube.apply(x)
return result
注意
backward 的输入，即 grad_output，也可以是跟踪历史的张量。因此，如果 backward 是用可微分操作（例如，调用另一个自定义 Function）实现的，则更高阶导数将起作用。在这种情况下，使用 save_for_backward 保存的张量也可以在 backward 中使用，并且会有梯度流回，但保存到 ctx 中的张量不会有梯度流回。如果您需要为保存到 ctx 中的张量流回梯度，您应该将其作为自定义 Function 的输出，并使用 save_for_backward 保存。
您可能想检查您实现的 backward 方法是否确实计算了函数的导数。这可以通过与使用小有限差分的数值近似进行比较来完成
from torch.autograd import gradcheck
# gradcheck takes a tuple of tensors as input, check if your gradient
# evaluated with these tensors are close enough to numerical
# approximations and returns True if they all verify this condition.
input = (torch.randn(20,20,dtype=torch.double,requires_grad=True), torch.randn(30,20,dtype=torch.double,requires_grad=True))
test = gradcheck(linear, input, eps=1e-6, atol=1e-4)
print(test)
有关有限差分梯度比较的更多详细信息，请参阅 数值梯度检查。如果您的函数用于高阶导数（对反向传递进行求导），您可以使用同一包中的 gradgradcheck 函数来检查高阶导数。
组合或分离的 forward() 和 setup_context()#
定义 Function 的主要有两种方式。要么
我们推荐第二种选项（独立的 forward() 和 setup_context()），因为这更接近 PyTorch 原生操作的实现方式，并且与 torch.func 转换兼容。然而，我们计划在未来继续支持这两种方法；将 forward() 与 setup_context() 结合：可以提供更大的灵活性，因为您无需将中间结果作为输出返回即可保存它们。
有关如何使用单独的 forward() 和 setup_context() 定义 Function，请参阅上一节。
这是一个如何定义组合 forward() 和 setup_context() 的 Function 的示例
class LinearFunction(Function):
@staticmethod
# ctx is the first argument to forward
def forward(ctx, input, weight, bias=None):
# The forward pass can use ctx.
ctx.save_for_backward(input, weight, bias)
output = input.mm(weight.t())
if bias is not None:
output += bias.unsqueeze(0).expand_as(output)
return output
@staticmethod
def backward(ctx, grad_output):
input, weight, bias = ctx.saved_tensors
grad_input = grad_weight = grad_bias = None
if ctx.needs_input_grad[0]:
grad_input = grad_output.mm(weight)
if ctx.needs_input_grad[1]:
grad_weight = grad_output.t().mm(input)
if bias is not None and ctx.needs_input_grad[2]:
grad_bias = grad_output.sum(0)
return grad_input, grad_weight, grad_bias
正向模式 AD#
覆盖正向模式 AD 公式具有非常相似的 API，但存在一些细微差别。您可以实现 jvp() 函数。
它将被赋予与输入数量相同的 Tensor 参数，每个参数表示相对于该输入的梯度。它应该返回与输出数量相同的张量，每个张量包含其对应输出的梯度。jvp() 将在 forward() 方法之后、apply() 返回之前调用。
jvp() 函数与 backward() 函数有几个细微的区别
您可以使用 ctx 将任何数据从
forward()传递给jvp()函数。如果这些状态在backward()中不需要，您可以在jvp()函数的末尾通过del ctx.foo显式释放它。jvp()的实现必须是反向可微分的，或者显式检查所给定的正向模式梯度都没有设置requires_grad。jvp()函数必须与forward()的视图/原地行为匹配。例如，如果第i个输入被原地修改，那么第i个梯度必须原地更新。同样，如果第j个输出是第k个输入的视图。那么返回的第j个输出梯度必须是给定第k个输入梯度的视图。由于用户无法指定需要计算哪个梯度，
jvp()函数应始终计算所有输出的梯度。正向模式梯度确实遵循
set_materialize_grads()设置的标志，当此功能禁用时，您可能会获得 None 输入梯度。
torch.func 转换和/或 torch.vmap()#
有关详细信息，请参阅 使用 autograd.Function 扩展 torch.func。
扩展 torch.nn#
nn 导出两种接口——模块及其函数式版本。您可以通过两种方式进行扩展，但我们建议将模块用于所有包含任何参数或缓冲区的层，并建议将函数式形式用于不带参数的操作，如激活函数、池化等。
在上面一节中，添加操作的函数式版本已经得到了全面介绍。
添加 Module#
由于 nn 大量使用 autograd，因此添加新的 Module 需要实现一个执行操作并能计算梯度的 Function。从现在开始，我们假设我们想实现一个 Linear 模块，并且我们已经按照上面的清单实现了该函数。添加它只需要很少的代码。现在，需要实现两个函数
这是一个 Linear 模块的实现方式
class Linear(nn.Module):
def __init__(self, input_features, output_features, bias=True):
super().__init__()
self.input_features = input_features
self.output_features = output_features
# nn.Parameter is a special kind of Tensor, that will get
# automatically registered as Module's parameter once it's assigned
# as an attribute. Parameters and buffers need to be registered, or
# they won't appear in .parameters() (doesn't apply to buffers), and
# won't be converted when e.g. .cuda() is called. You can use
# .register_buffer() to register buffers.
# nn.Parameters require gradients by default.
self.weight = nn.Parameter(torch.empty(output_features, input_features))
if bias:
self.bias = nn.Parameter(torch.empty(output_features))
else:
# You should always register all possible parameters, but the
# optional ones can be None if you want.
self.register_parameter('bias', None)
# Not a very smart way to initialize weights
nn.init.uniform_(self.weight, -0.1, 0.1)
if self.bias is not None:
nn.init.uniform_(self.bias, -0.1, 0.1)
def forward(self, input):
# See the autograd section for explanation of what happens here.
return LinearFunction.apply(input, self.weight, self.bias)
def extra_repr(self):
# (Optional)Set the extra information about this module. You can test
# it by printing an object of this class.
return 'input_features={}, output_features={}, bias={}'.format(
self.input_features, self.output_features, self.bias is not None
)
扩展 torch Python API#
您可以通过定义一个自定义类并使其方法与 Tensor 匹配来创建模拟 Tensor 的自定义类型。但是，如果您希望能够将这些类型传递给接受 Tensor 操作数的顶级 torch 命名空间中的函数，例如 torch.add()，该怎么办？
如果您的自定义 Python 类型定义了一个名为 __torch_function__ 的方法，当您的自定义类的实例传递给 torch 命名空间中的函数时，PyTorch 将调用您的 __torch_function__ 实现。这使得可以为 torch 命名空间中的任何函数定义自定义实现，您的 __torch_function__ 实现可以调用这些函数，从而允许您的用户将您的自定义类型与他们已经为 Tensor 编写的现有 PyTorch 工作流程一起使用。这适用于与 Tensor 无关的“鸭式”类型以及用户定义的 Tensor 子类。
使用类 Tensor 类型扩展 torch#
为了具体化这一点，让我们从一个简单的示例开始，它说明了 API 分派机制。我们将创建一个自定义类型来表示二维标量张量，由顺序 N 和对角线元素的值 value 参数化
class ScalarTensor(object):
def __init__(self, N, value):
self._N = N
self._value = value
def __repr__(self):
return "ScalarTensor(N={}, value={})".format(self._N, self._value)
def tensor(self):
return self._value * torch.eye(self._N)
这个设计的第一个迭代并不是很有用。ScalarTensor 的主要功能是提供比基本张量类更紧凑的标量张量字符串表示形式
>>> d = ScalarTensor(5, 2)
>>> d
ScalarTensor(N=5, value=2)
>>> d.tensor()
tensor([[2., 0., 0., 0., 0.],
[0., 2., 0., 0., 0.],
[0., 0., 2., 0., 0.],
[0., 0., 0., 2., 0.],
[0., 0., 0., 0., 2.]])
如果我们尝试将此对象与 torch API 一起使用，我们将遇到问题
>>> import torch
>>> torch.mean(d)
TypeError: mean(): argument 'input' (position 1) must be Tensor, not ScalarTensor
为 ScalarTensor 添加 __torch_function__ 实现可以使上述操作成功。让我们重新实现，这次添加 __torch_function__ 实现
HANDLED_FUNCTIONS = {}
class ScalarTensor(object):
def __init__(self, N, value):
self._N = N
self._value = value
def __repr__(self):
return "ScalarTensor(N={}, value={})".format(self._N, self._value)
def tensor(self):
return self._value * torch.eye(self._N)
@classmethod
def __torch_function__(cls, func, types, args=(), kwargs=None):
if kwargs is None:
kwargs = {}
if func not in HANDLED_FUNCTIONS or not all(
issubclass(t, (torch.Tensor, ScalarTensor))
for t in types
):
return NotImplemented
return HANDLED_FUNCTIONS[func](*args, **kwargs)
__torch_function__ 方法接受四个参数：func，对正在被覆盖的 torch API 函数的引用；types，实现 __torch_function__ 的类张量类型列表；args，传递给函数的参数元组；和 kwargs，传递给函数的关键字参数字典。它使用名为 HANDLED_FUNCTIONS 的全局分派表来存储自定义实现。此字典的键是 torch 命名空间中的函数，值是 ScalarTensor 的实现。
注意
使用全局分派表不是 __torch_function__ API 的强制组成部分，它只是组织覆盖实现的有用设计模式。
这个类定义还不足以让 torch.mean 在我们传递 ScalarTensor 时做出正确的行为——我们还需要为 ScalarTensor 操作数定义 torch.mean 的实现，并将该实现添加到 HANDLED_FUNCTIONS 分派表字典中。一种方法是定义一个装饰器
import functools
def implements(torch_function):
"""Register a torch function override for ScalarTensor"""
def decorator(func):
functools.update_wrapper(func, torch_function)
HANDLED_FUNCTIONS[torch_function] = func
return func
return decorator
它可以应用于我们覆盖的实现
@implements(torch.mean)
def mean(input):
return float(input._value) / input._N
有了这个改变，我们现在可以将 torch.mean 与 ScalarTensor 一起使用
>>> d = ScalarTensor(5, 2)
>>> torch.mean(d)
0.4
当然，torch.mean 是最简单的覆盖函数示例，因为它只接受一个操作数。我们可以使用相同的机制来覆盖接受多个操作数的函数，其中任何一个都可能是定义了 __torch_function__ 的张量或类张量，例如对于 torch.add()
def ensure_tensor(data):
if isinstance(data, ScalarTensor):
return data.tensor()
return torch.as_tensor(data)
@implements(torch.add)
def add(input, other):
try:
if input._N == other._N:
return ScalarTensor(input._N, input._value + other._value)
else:
raise ValueError("Shape mismatch!")
except AttributeError:
return torch.add(ensure_tensor(input), ensure_tensor(other))
此版本有一个快速路径，适用于两个操作数都是 ScalarTensor 实例的情况，还有一个慢速路径，当任一操作数不是 ScalarTensor 时，该路径会降级为将数据转换为张量。这使得覆盖函数在任一操作数是 ScalarTensor 或常规 Tensor 时都能正常工作
>>> s = ScalarTensor(2, 2)
>>> torch.add(s, s)
ScalarTensor(N=2, value=4)
>>> t = torch.tensor([[1, 1,], [1, 1]])
>>> torch.add(s, t)
tensor([[3., 1.],
[1., 3.]])
请注意，我们实现的 add 不像 torch.add() 那样将 alpha 或 out 作为关键字参数
>>> torch.add(s, s, alpha=2)
TypeError: add() got an unexpected keyword argument 'alpha'
为了速度和灵活性，__torch_function__ 分派机制不检查覆盖函数的签名是否与 torch API 中被覆盖函数的签名匹配。对于某些应用程序来说，忽略可选参数是可以的，但为了确保与 Tensor 的完全兼容性，用户实现的 torch API 函数应注意精确模拟被覆盖函数的 API。
torch API 中没有显式覆盖的函数将从 __torch_function__ 返回 NotImplemented。如果所有定义了 __torch_function__ 的操作数都返回 NotImplemented，PyTorch 将引发 TypeError。这意味着大多数情况下，没有针对特定类型显式覆盖的操作在传递该类型实例时会引发 TypeError
>>> torch.mul(s, 3)
TypeError: no implementation found for 'torch.mul' on types that
implement __torch_function__: [ScalarTensor]
实际上，这意味着如果您想沿着这些思路使用 __torch_function__ 实现您的重写，您将需要明确实现完整的 torch API 或您关心用例的 API 的整个子集。这可能是一个艰巨的任务，因为完整的 torch API 相当庞大。
另一个选择是对于未处理的操作不返回 NotImplemented，而是在没有可用覆盖时将 Tensor 传递给原始的 torch 函数。例如，如果我们将 ScalarTensor 的 __torch_function__ 实现更改为如下所示
@classmethod
def __torch_function__(cls, func, types, args=(), kwargs=None):
if kwargs is None:
kwargs = {}
if func not in HANDLED_FUNCTIONS or not all(
issubclass(t, (torch.Tensor, ScalarTensor))
for t in types
):
args = [a.tensor() if hasattr(a, 'tensor') else a for a in args]
return func(*args, **kwargs)
return HANDLED_FUNCTIONS[func](*args, **kwargs)
那么 torch.mul() 将正常工作，尽管返回类型将始终是 Tensor 而不是 ScalarTensor，即使两个操作数都是 ScalarTensor 实例
>>> s = ScalarTensor(2, 2)
>>> torch.mul(s, s)
tensor([[4., 0.],
[0., 4.]])
另请参阅下面的 MetadataTensor 示例，了解此模式的另一个变体，但它总是返回 MetadataTensor，以通过 torch API 中的操作传播元数据。
__torch_function__ 协议旨在全面覆盖 API，部分覆盖可能导致不良结果，特别是某些函数会引发 TypeError。对于子类尤其如此，其中 torch.add、torch.Tensor.__add__ 和 torch.Tensor.add 都必须覆盖，即使它们返回完全相同的结果。未能做到这一点也可能导致无限递归。如果需要从 torch.Tensor 子类实现函数，则必须在其实现中使用 super().__torch_function__。
子类化 torch.Tensor#
从版本 1.7.0 开始，torch.Tensor 上的方法以及应用于 torch.Tensor 子类的公共 torch.* 命名空间中的函数将返回子类实例而不是 torch.Tensor 实例
>>> class SubTensor(torch.Tensor):
... pass
>>> type(torch.add(SubTensor([0]), SubTensor([1]))).__name__
'SubTensor'
>>> type(torch.add(SubTensor([0]), torch.tensor([1]))).__name__
'SubTensor'
如果存在多个子类，默认情况下将选择层次结构中最低的子类。如果没有唯一的方法来确定这种情况，则会引发 TypeError
>>> type(torch.add(SubTensor2([0]), SubTensor([1]))).__name__
'SubTensor2'
>>> type(torch.add(SubTensor2([0]), torch.tensor([1]))).__name__
'SubTensor2'
>>> torch.add(SubTensor([0]), OtherSubTensor([1]))
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: no implementation found for 'torch.add' on types that implement __torch_function__: [SubTensor, OtherSubTensor]
如果希望对所有张量方法进行全局覆盖，可以使用 __torch_function__。这是一个记录所有函数/方法调用的示例
class LoggingTensor(torch.Tensor):
@classmethod
def __torch_function__(cls, func, types, args=(), kwargs=None):
# NOTE: Logging calls Tensor.__repr__, so we can't log __repr__ without infinite recursion
if func is not torch.Tensor.__repr__:
logging.info(f"func: {func.__name__}, args: {args!r}, kwargs: {kwargs!r}")
if kwargs is None:
kwargs = {}
return super().__torch_function__(func, types, args, kwargs)
然而，如果想重写 Tensor 子类上的方法，可以通过直接重写方法（通过为子类定义它），或者通过使用 __torch_function__ 并与 func 匹配来实现。
在子类的 __torch_function__ 中应该小心，始终调用 super().__torch_function__(func, ...) 而不是直接调用 func，就像 1.7.0 版本之前的情况一样。不这样做可能会导致 func 递归调用 __torch_function__，从而导致无限递归。
使用 Tensor 包装器类型扩展 torch#
另一个有用的情况是包装 Tensor 的类型，无论是作为属性还是通过子类化。下面我们实现这种类型的一个特例，一个 MetadataTensor，它将一个元数据字典附加到一个 Tensor 上，该元数据通过 torch 操作传播。由于这是一种对完整 torch API 的通用包装，我们不需要单独实现每个覆盖，因此我们可以使 __torch_function__ 实现对允许的操作更宽松
class MetadataTensor(object):
def __init__(self, data, metadata=None, **kwargs):
self._t = torch.as_tensor(data, **kwargs)
self._metadata = metadata
def __repr__(self):
return "Metadata:\n{}\n\ndata:\n{}".format(self._metadata, self._t)
@classmethod
def __torch_function__(cls, func, types, args=(), kwargs=None):
if kwargs is None:
kwargs = {}
metadatas = tuple(a._metadata for a in args if hasattr(a, '_metadata'))
args = [getattr(a, '_t', a) for a in args]
assert len(metadatas) > 0
ret = func(*args, **kwargs)
return MetadataTensor(ret, metadata=metadatas[0])
这个简单的实现不一定能与 torch API 中的每个函数一起工作，但它足以捕获大多数常见操作
>>> metadata = {'owner': 'Ministry of Silly Walks'}
>>> m = MetadataTensor([[1, 2], [3, 4]], metadata=metadata)
>>> t = torch.tensor([[1, 2], [1, 2]])
>>> torch.add(t, m)
Metadata:
{'owner': 'Ministry of Silly Walks'}
data:
tensor([[2, 4],
[4, 6]])
>>> torch.mul(t, m)
Metadata:
{'owner': 'Ministry of Silly Walks'}
data:
tensor([[1, 4],
[3, 8]])
定义 __torch_function__ 的多种类型上的操作#
可以使用 torch API 结合多个定义了 __torch_function__ 的不同类型，但必须特别注意。在这种情况下，规则是：
分派操作会收集每个操作数中所有不同的
__torch_function__实现，并按顺序调用它们：子类在超类之前，否则在运算符表达式中从左到右。如果返回除
NotImplemented以外的任何值，则该值作为结果返回。实现可以通过返回NotImplemented来注册它们不实现某项操作。如果所有
__torch_function__实现都返回NotImplemented，PyTorch 将引发TypeError。
PyTorch API 覆盖的测试覆盖率#
实现 __torch_function__ 的一个棘手之处在于，如果某些操作有覆盖而另一些没有，用户最多会看到不一致的体验，最坏情况下会在使用没有覆盖的函数时在运行时看到错误。为了简化此过程，PyTorch 提供了一个面向开发人员的 API，用于确保对 __torch_function__ 覆盖的完全支持。此 API 是私有的，将来可能会在不通知的情况下进行更改。
首先，要获取所有可覆盖函数的列表，请使用 torch.overrides._get_overridable_functions。这会返回一个字典，其键是 PyTorch Python API 中的命名空间，其值是该命名空间中可以被覆盖的函数列表。例如，我们打印 torch.nn.functional 中前 5 个可被覆盖的函数的名称
>>> from torch.overrides import get_overridable_functions
>>> func_dict = get_overridable_functions()
>>> nn_funcs = func_dict[torch.nn.functional]
>>> print([f.__name__ for f in nn_funcs[:5])
['adaptive_avg_pool1d', 'adaptive_avg_pool2d', 'adaptive_avg_pool3d',
'adaptive_max_pool1d', 'adaptive_max_pool1d_with_indices']
这个函数列表使得迭代所有可覆盖函数成为可能，但在实践中，这不足以编写所有这些函数的测试，而无需费力地手动复制每个函数的签名以进行每次测试。为了简化此过程，torch.overrides._get_testing_overrides 函数返回一个字典，将 PyTorch API 中可覆盖的函数映射到具有与原始函数相同签名但无条件返回 -1 的虚拟 lambda 函数。这些函数最适合与 inspect 一起使用，以分析原始 PyTorch 函数的函数签名
>>> import inspect
>>> from torch.overrides import get_testing_overrides
>>> override_dict = get_testing_overrides()
>>> dummy_add = override_dict[torch.add]
>>> inspect.signature(dummy_add)
<Signature (input, other, out=None)>
最后，torch.overrides.get_ignored_functions 返回一个函数元组，这些函数明确不能被 __torch_function__ 覆盖。此列表可用于确认未出现在 get_overridable_functions 返回的字典中的函数不能被覆盖。
扩展 torch 原生 API#
虽然 __torch_function__ 允许有效扩展 PyTorch 纯 Python 组件的行为，但它不允许扩展 PyTorch 中用 C++ 实现的部分。为此，Tensor 子类还可以定义 __torch_dispatch__，这将能够覆盖 C++ 级别的行为。
为了有效使用此功能，了解 PyTorch 的原生部分是如何实现非常重要。其中最重要的组件是我们所说的“调度器”（最好的描述可以在这篇 博客文章 中找到，尽管它略有更新）。顾名思义，它负责为函数的特定调用调用正确的后端函数。例如，当调用 torch.add(a, b) 时，调度器将检查两个参数，确定此特定调用应使用哪个“功能”（autograd、autocast、函数化等）和哪个“后端”（CPU、CUDA、MPS 等），最后调用所有正确的内核。内核非常常见的一件事是“重新调度”。例如，当在 GPU 上使用 autocast 运行神经网络时，第一次调用将是 autocast 内核，它将处理任何潜在的 autocast 逻辑并向下重新调度。下一行功能将是 autograd，它将正确创建 autograd 图，然后向下重新调度。最后，我们到达 CUDA 的后端内核，它将启动正确的 CUDA 内核并返回最终结果。在退出时，autograd 将图附加到输出，最后，autocast 将有机会在退出时进行任何更新。
调度器的一种配置是调用所有这些功能和后端键的顺序。最新列表及其顺序可以在 DispatchKey.h 中的 DispatchKey 枚举中找到。为了扩展 torch，此讨论中最重要的排序子集是
vmap -> 自动转换 -> 自动梯度 -> 零张量 -> 负/共轭 -> 函数化 -> Python -> 后端
对于本次讨论而言，最重要的键是 Python，因为所有定义了 __torch_dispatch__ 方法的 Tensor 子类都将调用此功能。从那里，用户定义的方法将被调用，并且行为可以被任意覆盖。从那里，再次调用提供的 func 将执行“重新调度”。
此实现的一些重要含义是
此代码在“所有功能之下”运行。因此，它仅负责（像常规后端一样）生成每个张量的输出值（并且可以并且应该忽略所有高级功能，例如自动梯度、自动转换等）。
如果任何高级功能在不重新调度的情况下实现了给定函数，它将永远不会到达
Python键，因此__torch_dispatch__回调将永远不会被触发。这特别适用于 CompositeImplicitAutograd 函数，这些函数在 Autograd 级别评估而无需重新调度。这是因为 CompositeImplicitAutograd 函数通过隐式调用其他原生操作来指定其 autograd 公式，因此在 Autograd 级别，该函数被分解为其原生操作并进行评估。当回调到 Python 并包装结果时，使用与常规 PyTorch Python/C++ 绑定相同的转换。特别是，有些对象无法在 Python 中表示，需要特殊处理（例如，未定义的张量变为 None）。
我们的原生函数被惰性地填充为
torch.ops.{namespace}.{func_name}.{overload_name}作为可调用 Python 对象，以便轻松地从 Python 与它们交互。传递给__torch_dispatch__的func对象始终是此命名空间中的一个条目。此命名空间可用于直接调用原生操作并绕过通常的 Python API 和绑定代码。
与 __torch_function__ 能够拦截 torch 的所有 Python API 和 Tensor 方法类似，__torch_dispatch__ 能够拦截所有对 aten 原生 API 的调用。请注意，Tensor 上的所有方法在进入调度器之前都会转换为函数调用，因此会在此处显示为函数调用：torch.add(a, 2) 和 a + 2 将导致完全相同的 aten 调用。大多数这些函数在 native_functions.yaml 中定义，其中指定了这些函数的属性及其后端实现。然后，它们的实现以及指定的功能通过代码生成自动注册。一些更奇特的函数或功能也注册在 C++ 代码库中的其他位置或用户定义的 C++ 扩展中。
也可以使用 torch.library 添加 新 的原生函数。此 Python 功能允许定义和/或为原生函数添加新的实现。这可用于添加缺失的内核、替换现有内核或定义全新的原生函数。
您可以在 subclass zoo 仓库中找到许多基于 __torch_dispatch__ 的子类示例。
__torch_dispatch__ 调用约定#
@classmethod
def __torch_dispatch__(cls, func, types, args=(), kwargs=None):
pass
当用户使用带有 __torch_dispatch__ 的输入调用运算符时，该调用可能会被转发到 __torch_dispatch__。args 和 kwargs 在调用 __torch_dispatch__ 之前会被规范化，也就是说
kwargs由运算符架构中的仅关键字参数组成。如果 kwarg 等于其默认值（在架构中），则不会传递。args包含所有其他参数，无论它们如何传递给运算符（位置参数或关键字参数）。如果某个参数等于其默认值，并且它是最右侧的位置参数，或者其右侧的所有参数都未传递，则不会传递该参数。
通过模式扩展所有 torch API#
不幸的是，有些函数不接受张量输入。这意味着上面描述的子类方法不能用于覆盖所有 PyTorch 函数的行为。此外，如果用例需要拦截每个函数调用，将每个张量更改为子类可能会过于侵入性。
为了解决这个用例，我们引入了“模式”的概念。这些模式分别存在于 __torch_function__ 和 __torch_dispatch__ 覆盖中，通过分别子类化 torch.overrides.TorchFunctionMode 和 torch.utils._python_dispatch.TorchDispatchMode 创建，并作为上下文管理器使用。
为了简化其与子类和其他模式交互的描述，每当进入模式的上下文管理器时，每个函数的行为都像在参数列表的开头有一个额外的 Tensor 参数，其模式作为子类。这意味着所有模式处理程序将在任何子类处理程序之前被调用，并且与内部上下文管理器对应的模式将始终首先运行。
还需要注意的是，在给定的模式处理程序中，此特定模式被禁用，可以通过执行 with self: 手动重新启用。
这是一个显示每种类型日志模式的示例
import torch
from torch.overrides import TorchFunctionMode, resolve_name
from torch.utils._python_dispatch import TorchDispatchMode
class FunctionLog(TorchFunctionMode):
def __torch_function__(self, func, types, args, kwargs=None):
print(f"Function Log: {resolve_name(func)}(*{args}, **{kwargs})")
return func(*args, **(kwargs or {}))
class DispatchLog(TorchDispatchMode):
def __torch_dispatch__(self, func, types, args, kwargs=None):
print(f"Dispatch Log: {func}(*{args}, **{kwargs})")
return func(*args, **(kwargs or {}))
def f():
a = torch.rand(10, requires_grad=True)
b = a * 2
b.sum().backward()
print("TorchFunctionMode logging:")
with FunctionLog():
f()
print("TorchDispatchMode logging:")
with DispatchLog():
f()
打印如下，并附有额外注释
TorchFunctionMode logging:
Function Log: torch.rand(*(10,), **{'requires_grad': True})
Function Log: torch.Tensor.mul(*(tensor([0.7164, 0.9897, 0.1745, 0.9336, 0.4287, 0.7989, 0.2169, 0.7474, 0.5624,
0.5970], requires_grad=True), 2), **None)
Function Log: torch.Tensor.sum(*(tensor([1.4328, 1.9794, 0.3490, 1.8671, 0.8573, 1.5977, 0.4338, 1.4948, 1.1249,
1.1939], grad_fn=<MulBackward0>),), **None)
# Note that at the python level, we only see the call to backward but not what happens in the autograd engine.
Function Log: torch.Tensor.backward(*(tensor(12.3307, grad_fn=<SumBackward0>),), **{'gradient': None, 'retain_graph': None, 'create_graph': False, 'inputs': None})
TorchDispatchMode logging:
# Here the requires_grad flag from autograd is removed while default arguments were populated.
Dispatch Log: aten.rand.default(*([10],), **{'device': device(type='cpu'), 'pin_memory': False})
Dispatch Log: aten.mul.Tensor(*(tensor([0.2151, 0.6018, 0.8415, 0.9060, 0.2974, 0.7708, 0.6668, 0.0352, 0.7948,
0.6023], requires_grad=True), 2), **{})
Dispatch Log: aten.sum.default(*(tensor([0.4303, 1.2036, 1.6831, 1.8120, 0.5949, 1.5416, 1.3335, 0.0705, 1.5897,
1.2046], grad_fn=<MulBackward0>),), **{})
# Here we don't see the call to backward itself, but its constituents. Starting here with the factory function that creates the initial gradient.
Dispatch Log: aten.ones_like.default(*(tensor(11.4637, grad_fn=<SumBackward0>),), **{'pin_memory': False, 'memory_format': torch.preserve_format})
# This is the backward of the sum
Dispatch Log: aten.expand.default(*(tensor(1.), [10]), **{})
Dispatch Log: aten.mul.Tensor(*(tensor([1., 1., 1., 1., 1., 1., 1., 1., 1., 1.]), 2), **{})
Dispatch Log: aten.detach.default(*(tensor([2., 2., 2., 2., 2., 2., 2., 2., 2., 2.]),), **{})
Dispatch Log: aten.detach.default(*(tensor([2., 2., 2., 2., 2., 2., 2., 2., 2., 2.]),), **{})