torch.overrides

创建于：2020 年 11 月 30 日 | 最后更新于：2025 年 6 月 6 日

此模块公开了用于 __torch_function__ 协议的各种辅助函数。有关 __torch_function__ 协议的更多详细信息，请参阅 扩展 PyTorch Python API。

函数

torch.overrides.get_ignored_functions()

返回无法被 __torch_function__ 覆盖的公共函数。

返回

torch API 中公开可用但不能使用 __torch_function__ 覆盖的函数元组。主要是因为这些函数中的任何参数都不是张量或类似张量的值。

返回类型

set[Callable]

示例

>>> torch.Tensor.as_subclass in torch.overrides.get_ignored_functions()
True
>>> torch.add in torch.overrides.get_ignored_functions()
False

torch.overrides.get_overridable_functions()

列出可通过 __torch_function__ 覆盖的函数

返回

一个字典，它将包含可覆盖函数的命名空间映射到该命名空间中可以被覆盖的函数。

返回类型

Dict[Any, List[Callable]]

torch.overrides.resolve_name(f)

获取传递给 __torch_function__ 的函数的易于阅读的字符串名称

参数

f (Callable) – 要解析名称的函数。

返回

函数的名称；如果求值，它应该返回输入函数。

返回类型

str

torch.overrides.get_testing_overrides()

返回一个包含所有可覆盖函数的虚拟覆盖的字典

返回

一个字典，它将 PyTorch API 中的可覆盖函数映射到具有与实际函数相同签名的 lambda 函数，并无条件地返回 -1。这些 lambda 函数对于测试支持 __torch_function__ 的类型的 API 覆盖率非常有用。

返回类型

Dict[Callable, Callable]

示例

>>> import inspect
>>> my_add = torch.overrides.get_testing_overrides()[torch.add]
>>> inspect.signature(my_add)
<Signature (input, other, out=None)>

torch.overrides.handle_torch_function(public_api, relevant_args, *args, **kwargs)

实现一个带有 __torch_function__ 覆盖检查的函数。

有关此函数在 C++ 实现中的等效项，请参阅 torch::autograd::handle_torch_function。

参数

• public_api (function) – 最初像 public_api(*args, **kwargs) 一样调用的公共 torch API 公开的函数，其参数正在被检查。

• relevant_args (iterable) – 用于检查 __torch_function__ 方法的参数的可迭代对象。

• args (tuple) – 最初传递给 public_api 的任意位置参数。

• kwargs (tuple) – 最初传递给 public_api 的任意关键字参数。

返回

调用 implementation 或 __torch_function__ 方法的结果，视情况而定。

返回类型

对象

:raises TypeError : 如果找不到实现。

示例

>>> def func(a):
...     if has_torch_function_unary(a):
...         return handle_torch_function(func, (a,), a)
...     return a + 0

torch.overrides.has_torch_function()

检查可迭代元素中的 __torch_function__ 实现，或者检查是否启用了 __torch_function__ 模式。将精确的 Tensor 和 Parameter 视为不可分派。使用此函数来保护对 handle_torch_function() 的调用；不要用它来测试一个东西是否是类似张量的，而是使用 is_tensor_like()。 :param relevant_args: 用于检查 __torch_function__ 方法的参数的可迭代对象。 :type relevant_args: iterable

返回

如果 relevant_args 的任何元素具有 __torch_function__ 实现，则返回 True，否则返回 False。

返回类型

布尔值

另请参阅

torch.is_tensor_like

检查一个东西是否是类似张量的，包括精确的 Tensor。

torch.overrides.is_tensor_like(inp)

如果传入的输入是类似张量的，则返回 True。

目前，这发生在输入类型上存在 __torch_function__ 属性时。

示例

张量的子类通常是类似张量的。

>>> class SubTensor(torch.Tensor): ...
>>> is_tensor_like(SubTensor([0]))
True

内置类型或用户定义的类型通常不是类似张量的。

>>> is_tensor_like(6)
False
>>> is_tensor_like(None)
False
>>> class NotATensor: ...
>>> is_tensor_like(NotATensor())
False

但是，可以通过实现 __torch_function__ 来使其成为类似张量的。

>>> class TensorLike:
...     @classmethod
...     def __torch_function__(cls, func, types, args, kwargs):
...         return -1
>>> is_tensor_like(TensorLike())
True

torch.overrides.is_tensor_method_or_property(func)

如果传入的函数是 __torch_function__ 传递给 torch.Tensor 的方法或属性的处理程序，则返回 True。

注意

对于属性，必须传入它们的 __get__ 方法。

这可能需要，特别是出于以下原因：

1. 方法/属性有时不包含 __module__ 插槽。

2. 它们要求传入的第一个参数是 torch.Tensor 的实例。

示例

>>> is_tensor_method_or_property(torch.Tensor.add)
True
>>> is_tensor_method_or_property(torch.add)
False

返回类型

布尔值

torch.overrides.wrap_torch_function(dispatcher)

使用 __torch_function__ 相关功能包装给定的函数。

参数

dispatcher (Callable) – 一个可调用对象，它返回传递给函数的类张量 (Tensor-like) 的可迭代对象。

注意

此装饰器可能会降低代码的性能。通常，将代码表示为一系列本身支持 __torch_function__ 的函数就足够了。如果您发现自己处于这种情况很少见，例如，如果您正在包装一个底层库，并且您也希望它适用于类张量，那么此函数可用。

示例

>>> def dispatcher(a):  # Must have the same signature as func
...     return (a,)
>>> @torch.overrides.wrap_torch_function(dispatcher)
>>> def func(a):  # This will make func dispatchable by __torch_function__
...     return a + 0