评价此页

torch.overrides#

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

此模块公开了 __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) – 要解析名称的函数。

返回

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

返回类型

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__ 方法的结果。

返回类型

对象

: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__ 模式。将确切的 TensorParameter 视为不可调度。使用此函数来保护对 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.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
返回类型

布尔值

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