torch.library

torch.library 是用于扩展 PyTorch 核心库的 API 集合 的运算符。它包含用于测试自定义运算符、创建新的 自定义运算符，以及使用 PyTorch 的 C++ 运算符定义的扩展运算符 注册 API（例如 aten 运算符）。

有关有效使用这些 API 的详细指南，请参阅 有关如何有效使用这些 API 的更多详细信息，请参阅 PyTorch 自定义运算符登录页面。

测试自定义操作

用于测试自定义运算中 Python torch.library 和/或 C++ TORCH_LIBRARY API。此外，如果您的操作员支持 training，用于测试梯度是否为 数学上正确。

torch.library 中。opcheck（op， args， kwargs=无， *， test_utils=（'test_schema'， 'test_autograd_registration'， 'test_faketensor'， 'test_aot_dispatch_dynamic'）， raise_exception=True）

给定一个运算符和一些示例参数，测试运算符是否为 已正确注册。

也就是说，当您使用 torch.library/TORCH_LIBRARY API 创建一个 自定义运算，您指定了有关自定义运算的元数据（例如可变性信息） 这些 API 要求您传递给它们的函数满足某些 属性（例如，在 fake/meta/abstract 内核中没有数据指针访问）测试这些元数据和属性。opcheck

具体来说，我们测试以下内容： - test_schema：如果 Operator 的 schema 正确。 - test_autograd_registration：如果 autograd 已注册。 - test_faketensor：如果算子有 FakeTensor 内核 （如果它是正确的）。FakeTensor 内核是必需的 （ 但还不够），以便运算符使用 PyTorch 编译 API （torch.compile/export/FX） 中。 - test_aot_dispatch_dynamic：如果操作员的行为正确 使用 PyTorch 编译 API （torch.compile/export/FX）。 这将检查输出（和梯度，如果适用）是否为 在 eager-mode PyTorch 和 torch.compile 下相同。 此测试是 的超集。test_faketensor

为获得最佳效果，请使用 代表性的输入集。如果您的运维支持 autograd，请与 input 一起使用; 如果您的运维支持多种设备（例如 CPU 和 CUDA），请 在所有支持的设备上与 Inputs 一起使用。opcheckopcheckrequires_grad = Trueopcheck

参数

• op （Union[OpOverload， OpOverloadPacket， CustomOpDef]） – 运算符。必须是用 OpOverload/OpOverloadPacket 修饰的函数 在 torch.ops.* 中找到（例如 torch.ops.aten.sin、torch.ops.mylib.foo）

• args （Tuple[Any， ...]） – 运算符的 args

• kwargs （Optional[Dict[str， Any]]） – 运算符的 kwargs

• test_utils （Union[str， Sequence[str]]） – 我们应该运行的测试。默认值：all of them。 示例：（“test_schema”， “test_faketensor”）

• raise_exception （bool） – 如果我们应该在第一个 错误。如果为 False，我们将返回一个包含信息 on 是否每个测试都通过。

返回类型

Dict[str， str]

警告

opcheck 并测试不同的东西; opcheck 测试您对 torch.library API 的使用是否正确，同时测试您的 autograd 公式是否正确 数学上正确。使用两者来测试支持 梯度计算。

例

>>> @torch.library.custom_op("mylib::numpy_mul", mutates_args=())
>>> def numpy_add(x: Tensor, y: float) -> Tensor:
>>>     x_np = x.numpy(force=True)
>>>     z_np = x_np + y
>>>     return torch.from_numpy(z_np).to(x.device)
>>>
>>> @numpy_sin.register_fake
>>> def _(x, y):
>>>     return torch.empty_like(x)
>>>
>>> def setup_context(ctx, inputs, output):
>>>     y, = inputs
>>>     ctx.y = y
>>>
>>> def backward(ctx, grad):
>>>     return grad * ctx.y, None
>>>
>>> numpy_sin.register_autograd(backward, setup_context=setup_context)
>>>
>>> sample_inputs = [
>>>     (torch.randn(3), 3.14),
>>>     (torch.randn(2, 3, device='cuda'), 2.718),
>>>     (torch.randn(1, 10, requires_grad=True), 1.234),
>>>     (torch.randn(64, 64, device='cuda', requires_grad=True), 90.18),
>>> ]
>>>
>>> for args in sample_inputs:
>>>     torch.library.opcheck(foo, args)

在 Python 中创建新的自定义运算

用于创建新的自定义操作。

torch.library 中。custom_op（name， fn=None， /， *， mutates_args， device_types=None， schema=None)

将函数包装到自定义运算符中。

您可能希望创建自定义运算的原因包括： - 包装第三方库或自定义内核以使用 PyTorch Autograd 等子系统。 - 防止 torch.compile/export/FX 跟踪窥视您的函数。

此 API 用作函数的装饰器（请参阅示例）。 提供的函数必须具有类型提示;这些是接口所必需的 与 PyTorch 的各种子系统一起使用。

参数

• name （str） – 自定义运算的名称，类似于 “{namespace}：：{name}”， 例如 “mylib：：my_linear”。该名称用作 op 的稳定标识符 在 PyTorch 子系统中（例如 torch.export、FX 图）。 为避免名称冲突，请使用您的项目名称作为命名空间; 例如，PyTorch/FBGEMM 中的所有自定义操作都使用“fbgemm”作为命名空间。

• mutates_args （Iterable[str]） – 函数更改的 args 的名称。 这必须是准确的，否则，行为是未定义的。

• device_types （无 | str |Sequence[str]） – 函数的设备类型 有效。如果未提供设备类型，则函数 用作所有设备类型的默认实现。 示例：“cpu”、“cuda”。

• schema （无 | str）– 运算符的架构字符串。如果没有 （推荐）我们将从运算符的类型推断出其 schema 附注。我们建议让我们推断一个 schema，除非你 有具体的原因不这样做。 示例：“（Tensor x， int y） -> （Tensor， Tensor）”。

返回类型

调用

注意

我们建议不要传入 arg，而是让我们推断 it 来自类型注释。编写自己的架构很容易出错。 您可能希望提供自己的架构，如果我们对 type 注解不是你想要的。 有关如何编写架构字符串的更多信息，请参阅此处schema

例子：：

>>> import torch
>>> from torch import Tensor
>>> from torch.library import custom_op
>>> import numpy as np
>>>
>>> @custom_op("mylib::numpy_sin", mutates_args=())
>>> def numpy_sin(x: Tensor) -> Tensor:
>>>     x_np = x.cpu().numpy()
>>>     y_np = np.sin(x_np)
>>>     return torch.from_numpy(y_np).to(device=x.device)
>>>
>>> x = torch.randn(3)
>>> y = numpy_sin(x)
>>> assert torch.allclose(y, x.sin())
>>>
>>> # Example of a custom op that only works for one device type.
>>> @custom_op("mylib::numpy_sin_cpu", mutates_args=(), device_types="cpu")
>>> def numpy_sin_cpu(x: Tensor) -> Tensor:
>>>     x_np = x.numpy()
>>>     y_np = np.sin(x_np)
>>>     return torch.from_numpy(y_np)
>>>
>>> x = torch.randn(3)
>>> y = numpy_sin_cpu(x)
>>> assert torch.allclose(y, x.sin())
>>>
>>> # Example of a custom op that mutates an input
>>> @custom_op("mylib::numpy_sin_inplace", mutates_args={"x"}, device_types="cpu")
>>> def numpy_sin_inplace(x: Tensor) -> None:
>>>     x_np = x.numpy()
>>>     np.sin(x_np, out=x_np)
>>>
>>> x = torch.randn(3)
>>> expected = x.sin()
>>> numpy_sin_inplace(x)
>>> assert torch.allclose(x, expected)

扩展自定义运算（从 Python 或 C++ 创建）

使用 register.* 方法，例如 和 func：torch.library.register_fake 添加实现 对于任何运算符（它们可能是使用 或 通过 PyTorch 的 C++ 操作员注册 API）。

torch.library 中。register_kernel（op， device_types， func=None， /， *， lib=None）

为此 Operator 的设备类型注册一个 implementation 。

一些有效的device_types是：“cpu”、“cuda”、“xla”、“mps”、“ipu”、“xpu”。 此 API 可用作装饰器。

参数

• fn （Callable） – 要注册为 implementation 的函数 给定的设备类型。

• device_types （无 | str |Sequence[str]） – 要将 impl 注册到的 device_types。 如果为 None，我们将注册到所有设备类型 - 请仅使用 如果您的实施确实与设备类型无关，则此选项。

例子：：

>>> import torch
>>> from torch import Tensor
>>> from torch.library import custom_op
>>> import numpy as np
>>>
>>> # Create a custom op that works on cpu
>>> @custom_op("mylib::numpy_sin", mutates_args=(), device_types="cpu")
>>> def numpy_sin(x: Tensor) -> Tensor:
>>>     x_np = x.numpy()
>>>     y_np = np.sin(x_np)
>>>     return torch.from_numpy(y_np)
>>>
>>> # Add implementations for the cuda device
>>> @torch.library.register_kernel("mylib::numpy_sin", "cuda")
>>> def _(x):
>>>     x_np = x.cpu().numpy()
>>>     y_np = np.sin(x_np)
>>>     return torch.from_numpy(y_np).to(device=x.device)
>>>
>>> x_cpu = torch.randn(3)
>>> x_cuda = x_cpu.cuda()
>>> assert torch.allclose(numpy_sin(x_cpu), x_cpu.sin())
>>> assert torch.allclose(numpy_sin(x_cuda), x_cuda.sin())

torch.library 中。register_autograd（op， backward， /， *， setup_context=None， lib=None）

为此自定义运算注册一个反向公式。

为了让操作员使用 autograd，您需要注册 一个倒退的公式： 1. 您必须告诉我们如何在向后传递期间计算梯度 通过为我们提供 “backward” 函数。 2. 如果您需要任何从 forward 到 calculate gradients 的值，您可以 使用 setup_context 保存 backward 的值。

backward在向后传球期间运行。它接受 ： - 是一个或多个渐变。梯度匹配的数量 运算符的输出数。 该对象与 使用的 ctx 对象相同。的语义是 与 相同。(ctx, *grads)gradsctxbackward_fn

setup_context(ctx, inputs, output)在向前传球期间运行。 请通过以下方式保存 backward 到 Object 上所需的数量 或将它们分配为 的属性。如果您的自定义运算具有 kwarg-only 参数，我们希望 的签名为 。ctxctxsetup_contextsetup_context(ctx, inputs, keyword_only_inputs, output)

两者都必须可追溯。那是 他们不能直接访问，但必须 不依赖于或更改全局状态。如果你需要一个不可追溯的向后， 您可以将其设为在 中调用的单独custom_op。setup_context_fnbackward_fnbackward_fn

例子

>>> import torch
>>> import numpy as np
>>> from torch import Tensor
>>>
>>> @torch.library.custom_op("mylib::numpy_sin", mutates_args=())
>>> def numpy_sin(x: Tensor) -> Tensor:
>>>     x_np = x.cpu().numpy()
>>>     y_np = np.sin(x_np)
>>>     return torch.from_numpy(y_np).to(device=x.device)
>>>
>>> def setup_context(ctx, inputs, output) -> Tensor:
>>>     x, = inputs
>>>     ctx.save_for_backward(x)
>>>
>>> def backward(ctx, grad):
>>>     x, = ctx.saved_tensors
>>>     return grad * x.cos()
>>>
>>> torch.library.register_autograd("mylib::numpy_sin", backward, setup_context=setup_context)
>>>
>>> x = torch.randn(3, requires_grad=True)
>>> y = numpy_sin(x)
>>> grad_x, = torch.autograd.grad(y, x, torch.ones_like(y))
>>> assert torch.allclose(grad_x, x.cos())
>>>
>>> # Example with a keyword-only arg
>>> @torch.library.custom_op("mylib::numpy_mul", mutates_args=())
>>> def numpy_mul(x: Tensor, *, val: float) -> Tensor:
>>>     x_np = x.cpu().numpy()
>>>     y_np = x_np * val
>>>     return torch.from_numpy(y_np).to(device=x.device)
>>>
>>> def setup_context(ctx, inputs, keyword_only_inputs, output) -> Tensor:
>>>     ctx.val = keyword_only_inputs["val"]
>>>
>>> def backward(ctx, grad):
>>>     return grad * ctx.val
>>>
>>> torch.library.register_autograd("mylib::numpy_mul", backward, setup_context=setup_context)
>>>
>>> x = torch.randn(3, requires_grad=True)
>>> y = numpy_mul(x, val=3.14)
>>> grad_x, = torch.autograd.grad(y, x, torch.ones_like(y))
>>> assert torch.allclose(grad_x, torch.full_like(x, 3.14))

torch.library 中。register_fake（op， func=无， /， *， lib=无， _stacklevel=1）

为此运算符注册一个 FakeTensor 实现（“fake impl”）。

有时也称为 “meta kernel”、“abstract impl”。

“FakeTensor implementation” 指定此运算符在 不携带数据的张量 （“FakeTensor”）。给定一些具有 某些属性 （sizes/strides/storage_offset/device） 指定 output Tensor 的属性是什么。

FakeTensor 实现具有与 operator 相同的签名。 它同时针对 FakeTensor 和 meta Tensors 运行。编写 FakeTensor implementation 中，假设算子的所有 Tensor input 都是 常规 CPU/CUDA/Meta 张量，但它们没有存储空间，以及 您正在尝试返回常规 CPU/CUDA/Meta 张量作为输出。 FakeTensor 实现必须仅包含 PyTorch 操作 （并且不得直接访问任何输入或 中间张量）。

此 API 可用作装饰器（参见示例）。

有关自定义操作的详细指南，请参阅 https://pytorch.org/tutorials/advanced/custom_ops_landing_page.html

例子

>>> import torch
>>> import numpy as np
>>> from torch import Tensor
>>>
>>> # Example 1: an operator without data-dependent output shape
>>> @torch.library.custom_op("mylib::custom_linear", mutates_args=())
>>> def custom_linear(x: Tensor, weight: Tensor, bias: Tensor) -> Tensor:
>>>     raise NotImplementedError("Implementation goes here")
>>>
>>> @torch.library.register_fake("mylib::custom_linear")
>>> def _(x, weight, bias):
>>>     assert x.dim() == 2
>>>     assert weight.dim() == 2
>>>     assert bias.dim() == 1
>>>     assert x.shape[1] == weight.shape[1]
>>>     assert weight.shape[0] == bias.shape[0]
>>>     assert x.device == weight.device
>>>
>>>     return (x @ weight.t()) + bias
>>>
>>> with torch._subclasses.fake_tensor.FakeTensorMode():
>>>     x = torch.randn(2, 3)
>>>     w = torch.randn(3, 3)
>>>     b = torch.randn(3)
>>>     y = torch.ops.mylib.custom_linear(x, w, b)
>>>
>>> assert y.shape == (2, 3)
>>>
>>> # Example 2: an operator with data-dependent output shape
>>> @torch.library.custom_op("mylib::custom_nonzero", mutates_args=())
>>> def custom_nonzero(x: Tensor) -> Tensor:
>>>     x_np = x.numpy(force=True)
>>>     res = np.stack(np.nonzero(x_np), axis=1)
>>>     return torch.tensor(res, device=x.device)
>>>
>>> @torch.library.register_fake("mylib::custom_nonzero")
>>> def _(x):
>>>     # Number of nonzero-elements is data-dependent.
>>>     # Since we cannot peek at the data in an fake impl,
>>>     # we use the ctx object to construct a new symint that
>>>     # represents the data-dependent size.
>>>     ctx = torch.library.get_ctx()
>>>     nnz = ctx.new_dynamic_size()
>>>     shape = [nnz, x.dim()]
>>>     result = x.new_empty(shape, dtype=torch.int64)
>>>     return result
>>>
>>> from torch.fx.experimental.proxy_tensor import make_fx
>>>
>>> x = torch.tensor([0, 1, 2, 3, 4, 0])
>>> trace = make_fx(torch.ops.mylib.custom_nonzero, tracing_mode="symbolic")(x)
>>> trace.print_readable()
>>>
>>> assert torch.allclose(trace(x), torch.ops.mylib.custom_nonzero(x))

torch.library 中。impl_abstract（qualname， func=None， *， lib=None， _stacklevel=1）

此 API 在 PyTorch 2.4 中已重命名。 请改用它。

torch.library 中。get_ctx（）

get_ctx（） 返回当前的 AbstractImplCtx 对象。

调用仅在 fake impl 内部有效 （有关更多使用详情，请参阅。get_ctx()

返回类型

抽象 ImplCtx

低级 API

以下 API 是 PyTorch 的 C++ 低级 API 的直接绑定 操作员注册 API。

警告

低级操作员注册 API 和 PyTorch Dispatcher 是一个 复杂的 PyTorch 概念。我们建议您使用上述更高级别的 API （不需要 torch.library.Library 对象）。 这篇博文 <http://blog.ezyang.com/2020/09/lets-talk-about-the-pytorch-dispatcher/>'_ 是了解 PyTorch Dispatcher 的良好起点。

Google Colab 上提供了指导您完成有关如何使用此 API 的一些示例的教程。

类 torch.library 中。库（ns， kind， dispatch_key=''）

用于创建可用于注册新运算符或 override Python 中现有库中的运算符。 如果用户只想注册，则可以选择传入 dispatch keyname kernels 只对应于一个特定的 dispatch key。

要创建一个库来覆盖现有库（名称为 ns）中的运算符，请将 kind 设置为 “IMPL”。 要创建一个新库（名称为 ns）来注册新的运算符，请将 kind 设置为 “DEF”。 要创建可能存在的库的片段以注册运算符（并绕过 给定命名空间只有一个库的限制），将 kind 设置为 “片段”。

参数

• NS – 库名称

• kind – “DEF”， “IMPL” （默认： “IMPL”）， “FRAGMENT”

• dispatch_key – PyTorch 调度密钥（默认值：“”）

define（schema， alias_analysis=''， *， tags=（）））

在 ns 命名空间中定义 new 运算符及其语义。

参数

• schema – 用于定义新运算符的函数 schema。

• alias_analysis （可选） – 指示运算符参数的别名属性是否可以 从架构 （默认行为） 推断出 （“CONSERVATIVE”） 或非 （“CONSERVATIVE”） 。

• 标签 （Tag | Sequence[Tag]） – 一个或多个火把。应用于此的标签 算子。标记运算符会更改运算符的行为 在各种 PyTorch 子系统下;请阅读 torch。应用前请仔细标记。

返回

从架构推断的运算符的名称。

例：：

>>> my_lib = Library("mylib", "DEF")
>>> my_lib.define("sum(Tensor self) -> Tensor")

impl（op_name， fn， dispatch_key=''， *， with_keyset=False）

为库中定义的运算符注册函数实现。

参数

• op_name – 运算符名称（以及重载）或 OpOverload 对象。

• fn – 作为 Input Dispatch Key 或注册 fallthrough 的运算符实现的函数。

• dispatch_key – 应为其注册输入函数的 dispatch 键。默认情况下，它使用 创建库时使用的 Dispatch 键。

例：：

>>> my_lib = Library("aten", "IMPL")
>>> def div_cpu(self, other):
>>>     return self * (1 / other)
>>> my_lib.impl("div.Tensor", div_cpu, "CPU")

torch.library 中。fallthrough_kernel（）

一个虚拟函数，用于注册 fallthrough。Library.impl

torch.library 中。define（qualname， schema， *， lib=None， tags=（））

torch.library 中。define（lib， 架构， alias_analysis='')

定义 new 运算符。

在 PyTorch 中，定义 op（“operator”的缩写）是一个两步过程： - 我们需要定义 OP（通过提供 Operator Name 和 schema） - 我们需要实现 Operator 如何与 各种 PyTorch 子系统，如 CPU/CUDA 张量、Autograd 等。

此入口点定义自定义运算符（第一步） 然后，您必须通过调用各种 API 来执行第二步，例如 或 。impl_*

参数

• qualname （str） – 运算符的限定名称。应该是 一个看起来像 “namespace：：name” 的字符串，例如 “aten：：sin”。 PyTorch 中的 Operator 需要一个命名空间来 避免名称冲突;给定的运算符只能创建一次。 如果您正在编写 Python 库，我们建议将命名空间设置为 是顶级模块的名称。

• schema （str） – 运算符的架构。例如“（Tensor x） -> Tensor” 对于接受一个 Tensor 并返回一个 Tensor 的运算。它确实 不包含运算符名称（在 中传递）。qualname

• lib （Optional[Library]） – 如果提供，则此运算符的生命周期 将与 Library 对象的生命周期相关联。

• 标签 （Tag | Sequence[Tag]） – 一个或多个火把。应用于此的标签 算子。标记运算符会更改运算符的行为 在各种 PyTorch 子系统下;请阅读 torch。应用前请仔细标记。

例：：

>>> import torch
>>> import numpy as np
>>>
>>> # Define the operator
>>> torch.library.define("mylib::sin", "(Tensor x) -> Tensor")
>>>
>>> # Add implementations for the operator
>>> @torch.library.impl("mylib::sin", "cpu")
>>> def f(x):
>>>     return torch.from_numpy(np.sin(x.numpy()))
>>>
>>> # Call the new operator from torch.ops.
>>> x = torch.randn(3)
>>> y = torch.ops.mylib.sin(x)
>>> assert torch.allclose(y, x.sin())

torch.library 中。impl（qualname， types， func=无， *， lib=无）

torch.library 中。impl（lib， name， dispatch_key='')

为此 Operator 的设备类型注册一个 implementation 。

你可以传递 “default” for 将此实现注册为 default 实现。 请仅在实现真正支持所有设备类型时才使用此项; 例如，如果它是内置 PyTorch 运算符的组合，则为 true。types

一些有效的类型是： “cpu”， “cuda”， “xla”， “mps”， “ipu”， “xpu”。

参数

• qualname （str） – 应为类似于 “namespace：：operator_name” 的字符串。

• 类型 （str | Sequence[str]） – 要将 impl 注册到的设备类型。

• lib （Optional[Library]） – 如果提供，则此注册的生命周期 将与 Library 对象的生命周期相关联。

例子

>>> import torch
>>> import numpy as np
>>>
>>> # Define the operator
>>> torch.library.define("mylib::mysin", "(Tensor x) -> Tensor")
>>>
>>> # Add implementations for the cpu device
>>> @torch.library.impl("mylib::mysin", "cpu")
>>> def f(x):
>>>     return torch.from_numpy(np.sin(x.numpy()))
>>>
>>> x = torch.randn(3)
>>> y = torch.ops.mylib.mysin(x)
>>> assert torch.allclose(y, x.sin())