torch.overrides

此模块公开了用于 __torch_function__ 协议的各种辅助函数。有关 __torch_function__ 协议的更多详细信息，请参阅 扩展 torch 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) – 要解析名称的函数。

返回

函数的名称；如果进行 eval，它应该返回输入函数。

返回类型

str

torch.overrides.get_testing_overrides()

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

返回

一个字典，将 PyTorch API 中的可覆盖函数映射到与其真实函数具有相同签名并无条件返回 -1 的 lambda 函数。这些 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() 的调用；不要使用它来测试某物是否是类张量，请改用 is_tensor_like()。 :param relevant_args: 要检查 __torch_function__ 方法的参数的迭代器。 :type relevant_args: iterable

返回

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

返回类型

bool

另请参阅

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.Tensor 的方法或属性的处理程序，则返回 True，因为它被传递到 __torch_function__ 中。

注意

对于属性，必须传入其 __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) – 返回传递给函数的类张量迭代器的可调用对象。

注意

此装饰器可能会降低代码的性能。通常，将代码表示为一系列本身支持 __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