评价此页
★ ★ ★ ★ ★
advanced/extend_dispatcher

在 C++ 中为新后端扩展调度器#

创建于：2021 年 2 月 1 日 | 最后更新：2024 年 9 月 23 日 | 最后验证：2024 年 11 月 5 日

在本教程中，我们将详细介绍扩展调度器以添加位于 pytorch/pytorch 仓库外部的新设备并对其进行维护以使其与原生 PyTorch 设备保持同步的所有必要步骤。在这里，我们假设您熟悉如何在 C++ 中注册调度操作符以及如何编写自定义自动求导函数。

注意

本教程涉及 PyTorch 内部的许多组件，这些组件正在积极改进中，如果您决定遵循本教程，请预料到 API 会发生变化。我们将使本教程与最新的 API 保持同步。

什么是新后端？#

向 PyTorch 添加新后端需要后端扩展器进行大量的开发和维护工作。在添加新后端之前，我们首先考虑一些常见的用例和推荐的解决方案：

  • 如果您有现有 PyTorch 操作符的新算法，请向 PyTorch 发送 PR。

  • 如果您想提出新的操作符，请向 PyTorch 发送功能请求/PR。

  • 如果您想添加对新设备/硬件（如 Google TPU 和定制芯片）的支持，这通常需要使用特定于硬件的 API 来编写内核，请遵循本教程并向 PyTorch 添加一个树外后端。

  • 如果您想添加对现有操作符的支持，但使用不同的 Tensor 布局/表示（如稀疏和量化），这会强制您的内核以更高效的方式编写，给定布局/表示限制，请遵循本教程并向 PyTorch 添加一个树外后端。

在本教程中，我们将主要关注添加一个新的树外设备。添加对不同张量布局的树外支持可能与设备有许多共同的步骤，但我们还没有看到此类集成的示例，因此可能需要 PyTorch 额外的工作来支持它。

获取后端调度键#

PyTorch 操作符以 C++ 实现，并通过 Python 绑定在 Python 前端提供。PyTorch 调度器将操作符的实现分为多个内核，每个内核都与一个特定的调度键关联。在 PyTorch 中支持新后端实质上意味着为每个 PyTorch 操作符编写一个 C++ 内核，然后将它们注册到调度器中代表您的自定义后端的调度键。

调度键是您在调度器系统中的标识符。调度器查看输入张量上的调度键并相应地调用正确的内核。PyTorch 提供了三个保留的调度键（及其相应的 Autograd 键）用于原型化树外后端扩展：

  • PrivateUse1/AutogradPrivateUse1

  • PrivateUse2/AutogradPrivateUse2

  • PrivateUse3/AutogradPrivateUse3

您可以选择以上任何键来原型化您的自定义后端。要在 PrivateUse1 后端上创建 Tensor，您需要在 TensorImpl 构造函数中设置调度键。

/* Example TensorImpl constructor */
TensorImpl(
    Storage&& storage,
    DispatchKeySet ks,
    const caffe2::TypeMeta data_type);

// To create a TensorImpl on PrivateUse1 backend, pass in the following ks to TensorImpl creation.
DispatchKeySet ks = c10::DispatchKeySet{c10::DispatchKey::PrivateUse1, c10::DispatchKey::AutogradPrivateUse1};

请注意，上面的 TensorImpl 类假设您的 Tensor 由存储支持，如 CPU/CUDA。我们还为没有存储的后端提供了 OpaqueTensorImpl。您可能需要调整/覆盖某些方法以适应您的自定义硬件。PyTorch 仓库中的一个示例是 Vulkan TensorImpl。

注意

原型完成后，如果您计划为您的后端扩展定期发布，请随时向 pytorch/pytorch 提交 PR 以保留一个专用的调度键用于您的后端。

获取 PyTorch 操作符的完整列表#

PyTorch 在生成的文件 build/aten/src/ATen/RegistrationDeclarations.h 中提供了可扩展 C++ 操作符的完整列表。此文件仅在从源代码构建 PyTorch 后可用。以下是该文件的一个片段：

Tensor abs(const Tensor & self); // {"schema": "aten::abs(Tensor self) -> Tensor", "dispatch": "True", "default": "True"}
Tensor & abs_(Tensor & self); // {"schema": "aten::abs_(Tensor(a!) self) -> Tensor(a!)", "dispatch": "True", "default": "True"}
Tensor & abs_out(Tensor & out, const Tensor & self); // {"schema": "aten::abs.out(Tensor self, *, Tensor(a!) out) -> Tensor(a!)", "dispatch": "True", "default": "False"}
Tensor absolute(const Tensor & self); // {"schema": "aten::absolute(Tensor self) -> Tensor", "dispatch": "False", "default": "False"}
Tensor & absolute_(Tensor & self); // {"schema": "aten::absolute_(Tensor(a!) self) -> Tensor(a!)", "dispatch": "False", "default": "False"}
Tensor & absolute_out(Tensor & out, const Tensor & self); // {"schema": "aten::absolute.out(Tensor self, *, Tensor(a!) out) -> Tensor(a!)", "dispatch": "False", "default": "False"}
Tensor angle(const Tensor & self); // {"schema": "aten::angle(Tensor self) -> Tensor", "dispatch": "True", "default": "True"}
Tensor & angle_out(Tensor & out, const Tensor & self); // {"schema": "aten::angle.out(Tensor self, *, Tensor(a!) out) -> Tensor(a!)", "dispatch": "True", "default": "False"}
Tensor sgn(const Tensor & self); // {"schema": "aten::sgn(Tensor self) -> Tensor", "dispatch": "True", "default": "True"}

单个操作符有多个字段。让我们以 abs_out 为例进行分解：

  • Tensor & abs_out(Tensor & out, const Tensor & self); 是操作符的 C++ 签名，您的 C++ 内核应该完全匹配此签名。

  • aten::abs.out(Tensor self, *, Tensor(a!) out) -> Tensor(a!) 是表示操作符的唯一 schema，它与 C++ 签名相比还包含别名和修改注释。这是调度器用于查找操作符的唯一标识符。

  • dispatch 和 default 是布尔字段，提供有关原生 PyTorch 内核可以做什么的信息，从而暗示后端扩展器是否需要实现该内核。更多详细信息可以在 为新后端注册内核 中找到。

为新后端注册内核#

要将您的内核注册到 PyTorch 调度器，您可以使用 在 C++ 中注册调度操作符 中描述的 TORCH_LIBRARY_IMPL API

TORCH_LIBRARY_IMPL(aten, PrivateUse1, m) {
  m.impl(<schema_my_op1>, &my_op1);
  m.impl(<schema_my_op2>, &my_op2);
  m.impl(<schema_my_op2_backward>, &my_op2_backward);
}

现在让我们深入了解哪些操作符需要自定义后端提供内核以及内核中到底包含什么。

PyTorch 目前有超过 1600 个操作符，并且还在不断增长。后端扩展要跟上这个速度是不现实的。即使对于 CPU 或 CUDA 等原生后端，为每个新操作符编写专用内核也通常需要大量工作。

幸运的是，一些原生 PyTorch 内核的编写方式是它们分解为几个已知操作符的组合。换句话说，您只需要实现一组已知操作符（下面需要注册的操作符），而不是所有 PyTorch 操作符。

PyTorch 操作符可以分为两类：

  • 需要注册的操作符：PyTorch 对这些操作符的原生实现是后端特定的，因此需要为自定义后端提供一个内核。否则，在自定义后端上调用此类操作符将出错。

    • 在 RegistrationDeclarations.h 中，这些操作符在其附带注释的元数据中，dispatch 设置为 True 并且 default 设置为 False。

  • 注册是可选的：后端扩展器可以跳过注册这些操作符而不会牺牲任何支持。但是，如果后端扩展器想要覆盖 PyTorch 提供的默认内核，他们仍然可以将自定义内核注册到他们的后端，调度器将仅将其用于您的后端。例如，PyTorch 的 max_pool2d 的当前实现将 indices 作为前向输出的一部分返回，这在 torch_xla 中会产生开销，因此 torch_xla 为 max_pool2d 注册自己的内核。

    • 在 RegistrationDeclarations.h 中，这些操作符在其附带注释的元数据中，dispatch 设置为 False 或 default 设置为 True。

新后端的自动求导支持#

梯度公式大多是纯数学的，因此适用于所有后端。PyTorch 通常将内核注册到别名调度键 Autograd，这意味着它可以被所有后端使用。

对于这些操作符，您无需担心它们的导数公式，您只需在 RegistrationDeclarations.h 中编写操作符的前向定义，PyTorch 会自动为您处理反向。

Tensor my_op1(const Tensor& self, const Tensor& other) {
  // call your backend-specific APIs to implement my_op so that
  // it matches PyTorch's native behavior
}
TORCH_LIBRARY_IMPL(aten, PrivateUse1, m) {
  m.impl(<schema_my_op1>, &my_op);
}

在某些情况下，PyTorch 的反向内核实现也是特定于设备的，以便它们可以从每个后端挤出最大性能。对于那些操作符，您会看到 op_backward 在 RegistrationDeclarations.h 中也显示为 必需注册。

Tensor my_op2_backward(const Tensor& self, const Tensor& other) {
  // call your backend-specific APIs to implement my_op2_backward so that
  // it matches PyTorch's native behavior
}

// Note backward kernel is still registered to PrivateUse1 instead of AutogradPrivateUse1.
// PyTorch will wrap your backward kernel with proper autograd setup and then link to it in
// my_op2's AutogradPrivateUse1 kernel.
TORCH_LIBRARY_IMPL(aten, PrivateUse1, m) {
  m.impl(<schema_my_op2>, &my_op2);
  m.impl(<schema_my_op2_backward>, &my_op2_backward);
}

在少数 罕见 情况下，PyTorch 对某些操作符的梯度公式可能存在不适用于所有后端的假设。在这些情况下，后端扩展器可以通过将 torch::autograd::Function 的内核注册到相应的调度键（例如，如果您的后端使用 PrivateUse1，则注册到 AutogradPrivateUse1）来选择性地覆盖 PyTorch Autograd 层。

class MyAddFunction : public torch::autograd::Function<MyAddFunction> {
  public:
  static Tensor forward(AutogradContext *ctx, torch::Tensor self, torch::Tensor other) {
    at::AutoNonVariableTypeMode g;
    return myadd(self, other);
  }

  static tensor_list backward(AutogradContext *ctx, tensor_list grad_outputs) {
    auto grad_output = grad_outputs[0];
    return {grad_output, grad_output};
  }
};

Tensor myadd_autograd(const Tensor& self, const Tensor& other) {
  return MyAddFunction::apply(self, other)[0];
}

// Register the autograd kernel to AutogradPrivateUse1
TORCH_LIBRARY_IMPL(aten, AutogradPrivateUse1, m) {
  m.impl(<myadd_schema>, &myadd_autograd);
}

// Register the inference kernel to PrivateUse1
TORCH_LIBRARY_IMPL(aten, PrivateUse1, m) {
  m.impl(<myadd_schema>, &myadd);
}

通过此技巧，您可以完全控制后端中 my_add 操作符的训练和推理行为。这是 pytorch/xla 仓库中的 一个示例。

构建扩展#

通过向 PyTorch 添加 C++ 扩展来支持树外后端。一旦您准备好内核和注册，您可以通过编写一个使用 setuptools 编译 C++ 代码的 setup.py 脚本来构建 C++ 扩展。这是 pytorch/xla 仓库 中的一个简化示例：

from setuptools import setup
from torch.utils.cpp_extension import BuildExtension, CppExtension

setup(
    name='torch_xla',
    ext_modules=[
        CppExtension(
            '_XLAC',
            torch_xla_sources,
            include_dirs=include_dirs,
            extra_compile_args=extra_compile_args,
            library_dirs=library_dirs,
            extra_link_args=extra_link_args + \
                [make_relative_rpath('torch_xla/lib')],
        ),
    ],
    cmdclass={
        'build_ext': Build,  # Build is a derived class of BuildExtension
    }
    # more configs...
)

有关更多详细信息，请参阅 我们的 C++ 扩展教程。

自定义操作符支持#

您的新后端应与在 python 中扩展的自定义操作符无缝协作，而无需编写任何新内核，只要自定义操作符由现有 PyTorch 操作符（您的后端已支持）组成。

对于在 C++ 中扩展的自定义操作符，它们通常附带特定于后端的 C++ 内核实现，例如 torchvision 中的 nms 内核以及自定义 Python API，例如 torch.ops.torchvision.nms。为了支持这些操作符，后端扩展器需要为您的后端编写一个 C++ 内核，并将其正确注册到调度器中的相应命名空间，类似于支持 PyTorch 原生操作符。或者，您也可以在您的扩展中添加一个自定义 API，例如 torch_xla.core.functions.nms 来处理这些临时请求。

JIT 支持#

正如我们在 在 C++ 中注册调度操作符 中提到的，通过 m.impl() API 注册的内核支持以未封装和封装两种方式调用。换句话说，您的自定义后端也可以像 CPU 或 CUDA 等树内后端一样与我们的 JIT 跟踪/脚本前端一起工作。您还可以为您的后端在 JIT 图上编写专门的优化遍。但我们在此不讨论它，因为我们尚未最终确定 JIT 中的集成点，因此当前的后端支持将暂时专注于急切前端。

测试您的后端与原生 PyTorch 后端#

PyTorch 允许使用其 通用设备类型测试框架 在多种设备类型上运行测试。您可以找到有关 测试如何使用它 的详细信息以及有关 如何添加新设备类型 的信息。一旦添加，使用通用设备类型测试框架的 PyTorch 测试也将使用您的设备类型运行。有关测试如何实例化的示例，请参见 此 Wiki 页面。

使用您的设备类型运行 PyTorch 现有测试套件对于确保正确性很重要，但并非所有 PyTorch 功能都受每种设备类型支持。通用设备类型测试框架允许大量自定义，以便设备类型可以选择运行哪些测试、支持哪些 dtypes，甚至在比较张量是否相等时使用哪些精度。

一个使用通用设备类型测试框架且不随 PyTorch 一起提供的设备类型示例是 XLA。请参阅 其对通用设备类型测试框架的扩展，其中包含阻塞列表测试、阻塞列表 dtypes 和覆盖测试精度的示例。

通用设备类型测试框架正在积极开发中。要请求功能，请在 PyTorch 的 Github 上提交问题。

向后兼容性#

目前 PyTorch 无法保证已注册操作符的向后兼容性。操作符及其 schema 可能会根据需要添加/修改/删除。已注册的内核必须与 PyTorch 版本 完全 相同。如果 PyTorch 为某个操作符添加了更多参数（即使带有默认值），您的旧注册将无法工作，直到更新以匹配 PyTorch 的新签名。

因此，我们 强烈建议 树外后端扩展器仅与 PyTorch 主要版本同步，以最大程度地减少开发中断。PyTorch 每季度发布一次。后端扩展器应加入 pytorch.slack.com 上的 #announcement 频道以获取最新的发布更新。

已知问题和附加说明#

  • 并非所有测试套件都已通用设备。可以通过在 PyTorch 代码库中搜索 instantiate_device_type_tests 来找到可扩展的测试类，例如 TestTorchDeviceType, TestViewOps, TestTensorDeviceOps, TestTypePromotion 等。

  • 在 C++ 中没有用于序列化自定义后端上的 python Tensor 对象的扩展点。目前，您只能通过修改 PyTorch Tensor __reduce_ex__ 方法 或在树外仓库中进行猴子补丁来扩展它。

  • 如果您的后端不允许直接内存访问，则应特别注意支持视图操作，因为它们应该共享存储。对视图张量的更改需要传播到其基础张量，反之亦然。

  • 如果您的后端不适用于原生 PyTorch 优化器，例如需要在反向传播中携带要更新的状态，例如 torch-xla，则在 C++ 中没有优化器的扩展点。此类用例目前只能通过添加自定义 API 或在树外仓库中进行猴子补丁来完成。

未来工作#

使 PyTorch 中的每个组件都可扩展以实现无缝的树外后端需要对 PyTorch 内部进行大量更改。以下是我们正在积极开展的一些项目，未来可能会改善体验：

  • 改进通用测试框架的测试覆盖率。

  • 改进 Math 内核覆盖率和更全面的测试，以确保 Math 内核行为与 CPU/CUDA 等其他后端匹配。

  • 重构 RegistrationDeclarations.h 以携带最少的信息并尽可能重用 PyTorch 的代码生成。

  • 支持后端回退内核，以自动将输入转换为 CPU，并将结果转换回自定义后端。这将允许“完整”的操作符覆盖，即使您没有为每个操作符编写内核。

保持联系#

请使用 PyTorch 开发者讨论 提问和讨论。如果您有任何功能请求或错误报告，请在 github 上提交问题。

如果您有兴趣帮助完成上述任何未来工作项目（例如为 C++ 中的 PyTorch 操作符添加更多 Math 内核），请通过 Github 或 Slack 联系我们！

在此页面上
PyTorch 库