内核注册¶

概述¶

在ExecuTorch 模型导出的最后阶段，我们将方言中的运算符降低到核心 ATen 运算符的输出变体。然后我们将这些运算符名称序列化到模型工件中。在运行时执行期间，对于每个运算符名称，我们需要找到实际的内核，即执行繁重计算并返回结果的 C++ 函数。

内核库¶

第一方内核库：¶

可移植内核库是内部默认内核库，涵盖了大部分核心 ATen 运算符。它易于使用/阅读，并用可移植的 C++17 编写。但是，它没有针对性能进行优化，因为它没有针对任何特定目标进行专门设计。因此，我们为 ExecuTorch 用户提供内核注册 API，以便他们可以轻松注册自己优化的内核。

优化内核库针对某些运算符的性能进行了专门设计，利用了现有的第三方库，例如EigenBLAS。这与可移植内核库配合使用效果最佳，在可移植性和性能之间取得了良好的平衡。此处提供了组合这两个库的一个示例。

量化内核库实现了量化和反量化运算符。这些是核心 ATen 运算符之外的运算符，但对于大多数生产用例至关重要。

自定义内核库：¶

实现核心 ATen 操作的自定义内核。虽然我们没有针对核心 ATen 操作的自定义内核的内部示例，但优化内核库可以作为很好的示例。我们已经优化了add.out和可移植的add.out。当用户组合这两个库时，我们提供 API 来选择要为add.out使用哪个内核。为了编写和使用实现核心 ATen 操作的自定义内核，建议使用基于 YAML 的方法，因为它提供了对以下方面的全面支持

组合内核库并定义回退内核；
使用选择性构建来最小化内核大小。

自定义运算符是 ExecuTorch 用户在 PyTorch 的native_functions.yaml之外定义的任何运算符。

运算符和内核契约¶

上面提到的所有内核，无论它们是内部内核还是自定义内核，都应符合以下要求

匹配从运算符模式派生的调用约定。内核注册 API 将为自定义内核生成标头作为参考。
满足边缘方言中定义的数据类型约束。对于具有某些数据类型作为参数的张量，自定义内核的结果需要与预期的数据类型匹配。这些约束在边缘方言操作中可用。
给出正确的结果。我们将提供一个测试框架来自动测试自定义内核。

API¶

以下是可用于将内核/自定义内核/自定义操作注册到 ExecuTorch 中的 API

YAML 条目 API
C++ API
- 用于自定义操作
- CMake 示例

如果不清楚使用哪个 API，请参阅最佳实践。

YAML 条目 API 高级架构¶

要求 ExecuTorch 用户提供

具有 C++ 实现的自定义内核库
与库关联的 YAML 文件，该文件描述此库正在实现哪些运算符。对于部分内核，yaml 文件还包含有关内核支持的数据类型和维度顺序的信息。有关详细信息，请参阅 API 部分。

YAML 条目 API 工作流程¶

在构建时，与内核库关联的 yaml 文件将与模型运算符信息一起传递给内核解析器（请参阅选择性构建文档），结果是运算符名称和张量元数据的组合与内核符号之间的映射。然后代码生成工具将使用此映射生成 C++ 绑定，以将内核连接到 ExecuTorch 运行时。ExecuTorch 用户需要将此生成的库链接到他们的应用程序中才能使用这些内核。

在静态对象初始化时，内核将注册到 ExecuTorch 内核注册表中。

在运行时初始化阶段，ExecuTorch 将使用运算符名称和参数元数据作为键来查找内核。例如，对于“aten::add.out”以及输入为维度顺序为 (0, 1, 2, 3) 的浮点张量，ExecuTorch 将进入内核注册表并查找与名称和输入元数据匹配的内核。

核心 ATen 运算符输出变体的 YAML 条目 API¶

顶级属性

op（如果运算符出现在 native_functions.yaml 中）或 func 用于自定义运算符。此键的值需要是 op 键的完整运算符名称（包括重载名称），或者是一个完整的运算符模式（命名空间、运算符名称、运算符重载名称和模式字符串），如果我们正在描述一个自定义运算符。有关模式语法，请参阅此说明。
kernels：定义内核信息。它由 arg_meta 和 kernel_name 组成，它们绑定在一起以描述“对于具有这些元数据的输入张量，使用此内核”。
type_alias（可选）：我们为可能的 dtype 选项提供别名。T0: [Double, Float] 表示 T0 可以是 Double 或 Float 之一。
dim_order_alias（可选）：类似于 type_alias，我们为可能的维度顺序选项提供名称。

在 kernels 下的属性

arg_meta：“张量参数名称”条目的列表。这些键的值是 dtype 和维度顺序别名，由相应的 kernel_name 实现。如果为 null，则表示内核将用于所有类型的输入。
kernel_name：将实现此运算符的 C++ 函数的预期名称。您可以在此处输入任何内容，但应遵循以下约定：将重载名称中的 . 替换为下划线，并将所有字符转换为小写。在此示例中，add.out 使用名为 add_out 的 C++ 函数。add.Scalar_out 将变为 add_scalar_out，其中 S 为小写。我们支持内核的命名空间，但请注意，我们将在命名空间的最后一级插入 native::。因此，kernel_name 中的 custom::add_out 将指向 custom::native::add_out。

一些运算符条目的示例

- op: add.out
  kernels:
    - arg_meta: null
      kernel_name: torch::executor::add_out

具有默认内核的核心 ATen 运算符的输出变体

具有 dtype/维度顺序专门化内核的 ATen 运算符（适用于 Double dtype，并且维度顺序需要为 (0, 1, 2, 3)）

- op: add.out
  type_alias:
    T0: [Double]
  dim_order_alias:
    D0: [[0, 1, 2, 3]]
  kernels:
    - arg_meta:
        self: [T0, D0]
        other: [T0 , D0]
        out: [T0, D0]
      kernel_name: torch::executor::add_out

自定义运算符的 YAML 条目 API¶

如上所述，此选项在选择性构建和合并运算符库等功能方面提供了更多支持。

首先，我们需要指定运算符模式以及 kernel 部分。因此，我们使用带有运算符模式的 func 代替 op。例如，以下是一个自定义运算符的 yaml 条目

- func: allclose.out(Tensor self, Tensor other, float rtol=1e-05, float atol=1e-08, bool equal_nan=False, bool dummy_param=False, *, Tensor(a!) out) -> Tensor(a!)
  kernels:
    - arg_meta: null
      kernel_name: torch::executor::allclose_out

kernel 部分与核心 ATen 运算符中定义的相同。对于运算符模式，我们正在重用在此 README.md 中定义的 DSL，但有一些差异

仅输出变体¶

ExecuTorch 仅支持输出样式运算符，其中

调用方在最后一个位置提供输出张量或张量列表，名称为 out。
C++ 函数修改并返回相同的 out 参数。
- 如果 YAML 文件中的返回类型为 ()（映射到 void），则 C++ 函数仍应修改 out，但不需要返回任何内容。
out 参数必须是关键字参数，这意味着它需要跟随一个名为 * 的参数，如下面的 add.out 示例所示。
按照惯例，这些输出运算符使用模式 <name>.out 或 <name>.<overload>_out 进行命名。

由于所有输出值都是通过 out 参数返回的，因此 ExecuTorch 会忽略实际的 C++ 函数返回值。但是，为了保持一致性，当返回类型为非 void 时，函数应始终返回 out。

只能返回 `Tensor` 或 `()`¶

ExecuTorch 仅支持返回单个 Tensor 或单元类型 ()（映射到 void）的运算符。它不支持返回任何其他类型，包括列表、可选类型、元组或标量，例如 bool。

支持的参数类型¶

ExecuTorch 不支持核心 PyTorch 支持的所有参数类型。以下是我们目前支持的参数类型列表

Tensor
int
bool
float
str
Scalar
ScalarType
MemoryFormat
Device
Optional
List
List<Optional>
Optional<List>

CMake 宏¶

我们提供构建时宏来帮助用户构建其内核注册库。该宏获取描述内核库以及模型运算符元数据的 yaml 文件，并将生成的 C++ 绑定打包到一个 C++ 库中。该宏在 CMake 上可用。

generate_bindings_for_kernels(FUNCTIONS_YAML functions_yaml CUSTOM_OPS_YAML custom_ops_yaml) 获取核心 ATen 运算符输出变体的 yaml 文件以及自定义运算符的 yaml 文件，生成内核注册的 C++ 绑定。它还依赖于 gen_selected_ops() 生成的选择性构建工件，有关更多信息，请参阅选择性构建文档。然后 gen_operators_lib 将这些绑定打包成一个 C++ 库。例如

# SELECT_OPS_LIST: aten::add.out,aten::mm.out
gen_selected_ops("" "${SELECT_OPS_LIST}" "")

# Look for functions.yaml associated with portable libs and generate C++ bindings
generate_bindings_for_kernels(FUNCTIONS_YAML ${EXECUTORCH_ROOT}/kernels/portable/functions.yaml)

# Prepare a C++ library called "generated_lib" with _kernel_lib being the portable library, executorch is a dependency of it.
gen_operators_lib("generated_lib" KERNEL_LIBS ${_kernel_lib} DEPS executorch)

# Link "generated_lib" into the application:
target_link_libraries(executorch_binary generated_lib)

我们还提供了合并两个 yaml 文件的功能，并给出了优先级。merge_yaml(FUNCTIONS_YAML functions_yaml FALLBACK_YAML fallback_yaml OUTPUT_DIR out_dir) 将 functions_yaml 和 fallback_yaml 合并到一个 yaml 中，如果 functions_yaml 和 fallback_yaml 中存在重复条目，则此宏将始终采用 functions_yaml 中的条目。

示例

# functions.yaml
- op: add.out
  kernels:
    - arg_meta: null
      kernel_name: torch::executor::opt_add_out

以及输出回退

# fallback.yaml
- op: add.out
  kernels:
    - arg_meta: null
      kernel_name: torch::executor::add_out

合并后的 yaml 将包含 functions.yaml 中的条目。

自定义运算符的 C++ API¶

与 YAML 条目 API 不同，C++ API 仅使用 C++ 宏 EXECUTORCH_LIBRARY 和 WRAP_TO_ATEN 进行内核注册，并且没有选择性构建支持。这使得此 API 在开发速度方面更快，因为用户无需进行 YAML 编写和构建系统调整。

请参阅自定义运算符最佳实践，了解要使用哪个 API。

与 PyTorch 中的 TORCH_LIBRARY 类似，EXECUTORCH_LIBRARY 获取运算符名称和 C++ 函数名称，并将它们注册到 ExecuTorch 运行时。

准备自定义内核实现¶

为函数变体（用于 AOT 编译）和输出变体（用于 ExecuTorch 运行时）定义您的自定义运算符模式。该模式需要遵循 PyTorch ATen 约定（请参阅 native_functions.yaml）。例如

custom_linear(Tensor weight, Tensor input, Tensor(?) bias) -> Tensor
custom_linear.out(Tensor weight, Tensor input, Tensor(?) bias, *, Tensor(a!) out) -> Tensor(a!)

然后使用 ExecuTorch 类型以及注册到 ExecuTorch 运行时的 API，根据模式编写您的自定义内核

// custom_linear.h/custom_linear.cpp
#include <executorch/runtime/kernel/kernel_includes.h>
Tensor& custom_linear_out(const Tensor& weight, const Tensor& input, optional<Tensor> bias, Tensor& out) {
   // calculation
   return out;
}

使用 C++ 宏将其注册到 ExecuTorch¶

在上面的示例中追加以下行

// custom_linear.h/custom_linear.cpp
// opset namespace myop
EXECUTORCH_LIBRARY(myop, "custom_linear.out", custom_linear_out);

现在我们需要为这个运算符编写一些包装器才能在 PyTorch 中显示，但不用担心，我们不需要重写内核。为此目的创建一个单独的 .cpp 文件

// custom_linear_pytorch.cpp
#include "custom_linear.h"
#include <torch/library.h>

at::Tensor custom_linear(const at::Tensor& weight, const at::Tensor& input, std::optional<at::Tensor> bias) {
    // initialize out
    at::Tensor out = at::empty({weight.size(1), input.size(1)});
    // wrap kernel in custom_linear.cpp into ATen kernel
    WRAP_TO_ATEN(custom_linear_out, 3)(weight, input, bias, out);
    return out;
}
// standard API to register ops into PyTorch
TORCH_LIBRARY(myop, m) {
    m.def("custom_linear(Tensor weight, Tensor input, Tensor(?) bias) -> Tensor", custom_linear);
    m.def("custom_linear.out(Tensor weight, Tensor input, Tensor(?) bias, *, Tensor(a!) out) -> Tensor(a!)", WRAP_TO_ATEN(custom_linear_out, 3));
}

编译和链接自定义内核¶

将其链接到 ExecuTorch 运行时：在构建二进制文件/应用程序的 CMakeLists.txt 中，我们需要将 custom_linear.h/cpp 添加到二进制文件目标中。我们也可以构建一个动态加载库（.so 或 .dylib）并将其链接。

以下是一个执行此操作的示例

# For target_link_options_shared_lib
include(${EXECUTORCH_ROOT}/build/Utils.cmake)

# Add a custom op library
add_library(custom_op_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/custom_op.cpp)

# Include the header
target_include_directory(custom_op_lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)

# Link ExecuTorch library
target_link_libraries(custom_op_lib PUBLIC executorch)

# Define a binary target
add_executable(custom_op_runner PUBLIC main.cpp)

# Link this library with --whole-archive !! IMPORTANT !! this is to avoid the operators being stripped by linker
target_link_options_shared_lib(custom_op_lib)

# Link custom op lib
target_link_libraries(custom_op_runner PUBLIC custom_op_lib)

将其链接到 PyTorch 运行时：我们需要将 custom_linear.h、custom_linear.cpp 和 custom_linear_pytorch.cpp 打包到一个动态加载库（.so 或 .dylib）中，并将其加载到我们的 python 环境中。一种方法是

import torch
torch.ops.load_library("libcustom_linear.so/dylib")

# Now we have access to the custom op, backed by kernel implemented in custom_linear.cpp.
op = torch.ops.myop.custom_linear.default

自定义算子 API 最佳实践¶

鉴于我们有两个用于自定义算子的内核注册 API，我们应该使用哪个 API？以下是每个 API 的优缺点

C++ API
- 优点
  - 只需要更改 C++ 代码
  - 类似于 PyTorch 自定义算子 C++ API
  - 维护成本低
- 缺点
  - 不支持选择性构建
  - 没有集中式簿记
Yaml 条目 API
- 优点
  - 支持选择性构建
  - 为自定义算子提供了一个集中式位置
    - 它显示了正在注册的算子和绑定到这些算子的内核，适用于应用程序
- 缺点
  - 用户需要创建和维护 yaml 文件
  - 更改算子定义的灵活性相对较差

总的来说，如果我们正在构建一个应用程序并且它使用自定义算子，在开发阶段建议使用 C++ API，因为它使用成本低且易于更改。一旦应用程序进入生产阶段，其中自定义算子定义和构建系统非常稳定并且需要考虑二进制文件大小，建议使用 Yaml 条目 API。

内核注册¶

概述¶

内核库¶

第一方内核库：¶

自定义内核库：¶

运算符和内核契约¶

API¶

YAML 条目 API 高级架构¶

YAML 条目 API 工作流程¶

核心 ATen 运算符输出变体的 YAML 条目 API¶

自定义运算符的 YAML 条目 API¶

仅输出变体¶

只能返回 `Tensor` 或 `()`¶

支持的参数类型¶

CMake 宏¶

自定义运算符的 C++ API¶

准备自定义内核实现¶

使用 C++ 宏将其注册到 ExecuTorch¶

编译和链接自定义内核¶

自定义算子 API 最佳实践¶

文档

教程

资源

内核注册¶

概述¶

内核库¶

第一方内核库：¶

自定义内核库：¶

运算符和内核契约¶

API¶

YAML 条目 API 高级架构¶

YAML 条目 API 工作流程¶

核心 ATen 运算符输出变体的 YAML 条目 API¶

自定义运算符的 YAML 条目 API¶

仅输出变体¶

只能返回 Tensor 或 ()¶

支持的参数类型¶

CMake 宏¶

自定义运算符的 C++ API¶

准备自定义内核实现¶

使用 C++ 宏将其注册到 ExecuTorch¶

编译和链接自定义内核¶

自定义算子 API 最佳实践¶

文档

教程

资源

只能返回 `Tensor` 或 `()`¶