torch.overrides

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

函数

torch.overrides.get_ignored_functions()

返回无法通过 __torch_function__ 重写的公共函数。

返回

一个函数元组，这些函数在 torch API 中公开可用，但无法通过 __torch_function__ 重写。这主要是因为这些函数的参数都不是 tensor 或 tensor-like 对象。

返回类型

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) – 要解析名称的函数。

返回

函数的名称；如果 eval 后，应返回输入的函数。

返回类型

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) – 由 torch 公共 API 暴露的函数，最初调用方式为 public_api(*args, **kwargs)，现在正在检查其参数。

• relevant_args (iterable) – 要检查 __torch_function__ 方法的参数迭代器。

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

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

返回

根据需要，调用 implementation 或 __torch_function__ 方法的结果。

返回类型

object

: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() 的调用；不要用它来测试某个对象是否是 Tensor-like，而应使用 is_tensor_like()。 :param relevant_args: 要检查 __torch_function__ 方法的迭代器或参数。 :type relevant_args: iterable

返回

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

返回类型

bool

另请参见

torch.is_tensor_like

检查某个对象是否是 Tensor-like，包括精确的 Tensor。

torch.overrides.is_tensor_like(inp)

如果传入的输入是 Tensor-like，则返回 True。

目前，当输入类型的属性中存在 __torch_function__ 时，就会发生这种情况。

示例

tensor 的子类通常是 Tensor-like。

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

内置或用户类型通常不是 Tensor-like。

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

但是，可以通过实现 __torch_function__ 使它们成为 Tensor-like。

>>> 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.Tensor 的方法或属性的 handler，并且被传递给 __torch_function__，则返回 True。

注意

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

这可能特别需要，原因如下：

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

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

示例

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

返回类型

bool

torch.overrides.wrap_torch_function(dispatcher)

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

参数

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

注意

此装饰器可能会降低代码性能。通常，只需将代码表达为一系列本身支持 __torch_function__ 的函数即可。如果您发现自己处于极少数情况下，例如您正在包装一个底层库并且还需要它支持 Tensor-like 对象，那么此函数可用。

示例

>>> 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