ExecuTorch 运行时 API 参考

ExecuTorch C++ API 为导出的 PyTorch 模型提供设备端执行框架。

有关运行时API的教程风格介绍，请查看 运行时教程 及其 简化版。

有关API如何演变和弃用过程的详细信息，请参阅ExecuTorch API生命周期和弃用政策。

模型加载与执行

class Program

一个反序列化的 ExecuTorch 程序二进制文件。

公共类型

enum class Verification : uint8_t

在解析数据之前，程序可以执行的验证类型。

Values:

enumerator Minimal

对数据进行最小化验证，确保表头显示正确。

具有最小的运行时开销。

enumerator InternalConsistency

对数据进行完整验证，确保内部指针自洽，且数据未被截断或明显损坏。可能无法检测所有类型的损坏，但应能防止解析过程中的非法内存操作。

运行时开销更高，且随程序数据的复杂度增加而增大。

enum HeaderStatus

描述 ExecuTorch 程序头的存在。

Values:

enumerator CompatibleVersion

已存在 ExecuTorch 程序头，且其版本与此运行时版本兼容。

enumerator IncompatibleVersion

存在 ExecuTorch 程序头，但其版本与此运行时版本不兼容。

enumerator NotPresent

未检测到 ExecuTorch 程序头。

enumerator ShortData

提供的数据过短，无法找到程序头。

公共函数

Result<const void*> get_constant_buffer_data(size_t buffer_idx, size_t nbytes) const

使用索引 buffer_idx 获取 程序 中的常量缓冲区。

Parameters

• buffer_idx – [in] constant_buffer 中缓冲区的索引。

• nbytes – [输入] 要从缓冲区读取的字节数。

Returns

具有相应索引的缓冲区。

size_t num_methods() const

返回程序中的方法数量。

Result<const char*> get_method_name(size_t method_index) const

返回特定索引处的方法名称。

Parameters

method_index – [in] 要检索的方法名称的索引。必须小于 num_methods() 返回的值。

Returns

请求方法的名称。指针由程序拥有，并且与程序具有相同的生命周期。

Result<Method> load_method(const char *method_name, MemoryManager *memory_manager, EventTracer *event_tracer = nullptr) const

加载指定方法并准备执行。

Parameters

• method_name – [in] 要加载的方法名称。

• memory_manager – [输入] 在加载方法的初始化和执行期间要使用的分配器。如果 memory_manager.temp_allocator() 为 null，运行时将使用 et_pal_allocate() 分配临时内存。

• event_tracer – [输入] 用于此方法运行的事件追踪器。

Returns

加载成功时返回方法，失败时返回错误。

Result<MethodMeta> method_meta(const char *method_name) const

收集指定方法的元数据。

Parameters

method_name – [in] 要获取元数据的方法名称。

ET_DEPRECATED Result< const char * > get_output_flattening_encoding (const char *method_name="forward") const

已弃用：获取输出的 pytree 编码字符串。此功能最终将移至核心程序之外的高层结构中，但目前该结构尚不存在，因此本功能已弃用。

Parameters

method_name – [in] 要获取编码的方法名称。

Returns

输出的 pytree 编码字符串

公共静态函数

static ET_NODISCARD Result< Program > load (DataLoader *loader, Verification verification=Verification::Minimal)

从提供的加载器中加载一个程序。这个程序将持有一个指向加载器的指针，该加载器的生命周期必须长于返回的程序实例。

Parameters

• loader – [in] 加载程序数据的源。Program将持有指向此 loader 的指针，该 loader 的生命周期必须长于返回的 Program 实例。

• 验证 – [输入] 在返回成功之前要执行的验证类型。

static inline ET_DEPRECATED ET_NODISCARD Result< Program > Load (DataLoader *loader, Verification verification=Verification::Minimal)

已弃用：请使用小写的 load() 代替。

static HeaderStatus check_header(const void *data, size_t size)

在提供的数据中查找 ExecuTorch 程序头。

Parameters

• data – [输入] 来自文件开头的数据，该文件可能包含 ExecuTorch 程序。

• size – [输入] data 的大小（以字节为单位）。必须 >= kMinHeadBytes。

Returns

描述数据中是否存在表头的值。

公共静态属性

static constexpr size_t kMinHeadBytes = 64

调用 check_header 所需的最小字节数。

class Method

Executorch 程序的可执行方法。映射到原始 nn.Module 上的 Python 方法，例如 forward()。

公共函数

inline Method(Method &&rhs) noexcept

移动构造函数。获取之前由rhs拥有的资源的所有权，并使rhs处于未初始化状态。

ET_NODISCARD Error set_input (const EValue &input_evalue, size_t input_idx)

将内部输入值设置为与提供的值等效。

Parameters

• input_evalue – [in] 要复制到方法输入中的 evalue。如果 evalue 是张量，在大多数情况下数据会被复制，因此此处传入的张量不一定需要在此调用结束后继续存在。但有一种情况是，Method 将保留指向张量数据的指针。根据方法的内存计划，输入可能没有预先分配缓冲区空间。在这种情况下，执行器将别名此处作为输入提供的张量的内存，而不是将输入深度复制到计划的内存区域中。

• input_idx – [in] 要设置的输入的从零开始的索引。必须小于 inputs_size() 返回的值。

Returns

成功时返回 Error::Ok，失败时返回非 Ok。

ET_NODISCARD Error set_inputs (const executorch::aten::ArrayRef< EValue > &input_evalues)

设置所有方法输入的值。

请参阅 set_input() 以获取更详细的行为描述。

Parameters

input_evalues – [in] 所有方法输入的新值。每个元素的类型必须与对应输入的类型匹配。如果元素的值是张量，则尝试允许动态形状，但数据类型必须始终一致。

Returns

成功时返回 Error::Ok，失败时返回非 Ok。

ET_NODISCARD Error set_output_data_ptr (void *buffer, size_t size, size_t output_idx)

将指定方法输出的数据缓冲区设置为提供的值。

注意：根据该方法的内存规划，输出张量可能未预先分配缓冲区空间。在这种情况下，执行器会将这些张量指向此处提供的缓冲区，因此用户需确保该内存的生命周期长于执行器的前向传播过程。

Parameters

• buffer – [输入] 指向指定张量的内存块。

• size – [in] 缓冲区长度（以字节为单位），必须大于或等于指定张量的 nbytes。

• output_idx – [in] 要设置 data_ptr 的输出索引。必须对应一个张量，且该张量尚未由内存计划分配缓冲区。

Returns

成功时返回 Error::Ok，失败时返回非 Ok。

ET_NODISCARD Error get_outputs (EValue *output_evalues, size_t length)

将方法的输出复制到提供的数组中。

警告：输出包含内部张量输出的浅层副本。请勿修改返回的 Tensor 元素。

TODO(T139259264)：添加检查以检测输出变异，或对输出进行深拷贝。

Parameters

• output_evalues – [in] 用于复制输出结果的数组。前outputs_size()个元素将被设置为相应的输出值。数组的其余部分将被设置为EValue值 None。

• length – [输入] 大小为 output_evalues 的数组的元素数量。必须大于或等于 outputs_size()。

Returns

成功时返回 Error::Ok，失败时返回非 Ok。

ET_NODISCARD Error get_inputs (EValue *input_evalues, size_t length)

将方法的输入复制到提供的数组中。

警告：输入包含内部张量输入的浅层副本。请勿修改返回的张量元素。

Parameters

• input_evalues – [in] 要复制输入值的数组。前inputs_size()个元素将设置为相应的输入值。数组的其余部分将设置为EValue值 None。

• length – [输入] 大小为 input_evalues 的数组的元素数量。必须大于或等于 inputs_size()。

Returns

成功时返回 Error::Ok，失败时返回非 Ok。

ET_NODISCARD Error execute ()

执行该方法。

注意：如果方法已通过 step() API 部分执行，将会失败。

Returns

成功时返回 Error::Ok，失败时返回非 Ok。

ET_EXPERIMENTAL ET_NODISCARD Error step ()

实验性：在方法中推进并执行单条指令。

Return values

• 错误::成功 – 步骤执行成功

• 非 Ok – 步骤失败

• 错误::方法结束 – 方法已成功执行完毕

ET_DEPRECATED ET_NODISCARD Error experimental_step ()

已弃用：请使用 step() 代替。

ET_EXPERIMENTAL ET_NODISCARD Error reset_execution ()

实验性功能：将执行状态重置为方法的开始。与step() API一起使用。

Return values

• 错误：成功 – 操作成功时

• 错误::无效状态 – 如果在基于步骤的执行到达方法末尾之前调用。这意味着无法恢复在执行中途失败的方法。

ET_DEPRECATED ET_NODISCARD Error experimental_reset_execution ()

已弃用：请使用 reset_execution() 代替。

MethodMeta method_meta() const

返回与调用 MethodMeta 对应的 Method。

size_t inputs_size() const

返回 方法 预期的输入数量。

size_t outputs_size() const

返回 方法 返回的输出数量。

const EValue &get_output(size_t i) const

获取指定索引处的输出。

ET_DEPRECATED const EValue & get_input (size_t i) const

已弃用：请使用 MethodMeta 来访问元数据，并使用 set_input 来更新 Method 的输入。

ET_DEPRECATED EValue & mutable_input (size_t i)

已弃用：请使用 MethodMeta 来访问元数据，并使用 set_input 来更新 Method 的输入。

ET_DEPRECATED EValue & mutable_output (size_t i)

已弃用：请使用 MethodMeta 来访问元数据，并使用 get_output 检索 Method 的输出。

class MethodMeta

描述 ExecuTorch 程序中的一种方法。

用于创建 MethodMeta 对象的程序必须比 MethodMeta 对象存活得更久。它与 Method 分离，以便在不支付加载完整 Method 的初始化成本的情况下访问此信息。

公共函数

const char *name() const

获取此方法的名称。

Returns

方法名称。

size_t num_inputs() const

获取此方法的输入数量。

Returns

输入的数量。

Result<Tag> input_tag(size_t index) const

获取指定输入的标签。

Parameters

index – [in] 要查找的输入索引。

Returns

输入标签，只能是 [Tensor, Int, Bool, Double, String]。

Result<TensorInfo> input_tensor_meta(size_t index) const

获取指定输入的元数据。

Parameters

index – [in] 要查找的输入索引。

Returns

成功时的元数据，或失败时的错误。仅对 tag::Tensor 有效

size_t num_outputs() const

获取此方法的输出数量。

Returns

输出数量。

Result<Tag> output_tag(size_t index) const

获取指定输出的标签。

Parameters

index – [in] 要查找的输出索引。

Returns

输出标签只能是 [Tensor, Int, Bool, Double, String]。

Result<TensorInfo> output_tensor_meta(size_t index) const

获取指定输出的元数据。

Parameters

index – [in] 要查找的输出索引。

Returns

成功时的元数据，或失败时的错误。仅对 tag::Tensor 有效

size_t num_memory_planned_buffers() const

获取此方法所需的内存规划缓冲区数量。

Returns

内存规划缓冲区的数量。

Result<int64_t> memory_planned_buffer_size(size_t index) const

获取指定内存规划缓冲区的大小（以字节为单位）。

Parameters

index – [in] 要查找的缓冲区的索引。

Returns

成功时返回字节大小，失败时返回错误。

ET_EXPERIMENTAL size_t num_instructions () const

获取此方法中的指令数量。

Returns

指令数量。

inline ET_DEPRECATED size_t num_non_const_buffers () const

已弃用：请使用 num_memory_planned_buffers() 替代。

inline Result<int64_t> non_const_buffer_size(size_t index) const

已弃用：请使用 memory_planned_buffer_size() 替代。

class DataLoader

从数据源加载。

参见 //executorch/extension/data_loader 以获取常见实现。

公共函数

virtual ET_NODISCARD Result< FreeableBuffer > load (size_t offset, size_t size, const SegmentInfo &segment_info) const =0

从底层数据源加载数据。

注意：这必须是线程安全的。如果此调用修改了共享状态，实现必须自行加锁。

Parameters

• offset – 数据源中开始加载的字节偏移量。

• size – 要加载的字节数。

• segment_info – 关于正在加载的段的信息。

Returns

一个 FreeableBuffer，它拥有加载的数据。

inline virtual ET_NODISCARD Error load_into (size_t offset, size_t size, const SegmentInfo &segment_info, void *buffer) const

从底层数据源加载数据到提供的缓冲区中。

注意：这必须是线程安全的。如果此调用修改了共享状态，实现必须自行加锁。

Parameters

• offset – 数据源中开始加载的字节偏移量。

• size – 要加载的字节数。

• segment_info – 关于正在加载的段的信息。

• buffer – 要加载数据到的缓冲区。必须指向至少 size 字节的内存。

Returns

一个指示加载是否成功的错误。

virtual ET_NODISCARD Result< size_t > size () const =0

返回底层数据源的长度，通常为文件大小。

struct SegmentInfo

描述该片段的内容。

公共类型

enum class Type

表示该段落的用途。

Values:

enumerator Program

实际程序的数据。

enumerator Constant

保存常量张量数据。

enumerator Backend

用于初始化后端的數據。

enumerator Mutable

用于初始化可变张量的数据。

公开成员

Type segment_type

段的类型。

size_t segment_index

段列表内段的索引。程序段未定义。

const char *descriptor

描述该分段的可选、以 null 结尾的字符串。对于 Backend 分段，这是后端 ID。其他分段类型则为 null。

class MemoryAllocator

一个基于大小进行简单分配并返回内存地址指针的类。它会为特定大小的缓冲区设置书签。该分配机制仅检查空间，并在每次分配请求时递增 cur_ 指针。

简单示例：

// 用户在堆上分配了 100 字节的内存。uint8_t* memory_pool = malloc(100 * sizeof(uint8_t)); MemoryAllocator allocator(100, memory_pool) // 将分配器对象传递给执行器

在底层，ExecuTorch 将调用 allocator.allocate() 以持续迭代 cur_ 指针。

由 executorch::runtime::internal::PlatformMemoryAllocator 子类化

公共函数

inline MemoryAllocator(uint32_t size, uint8_t *base_address)

构造一个新的内存分配器，其大小为给定的size，并从提供的base_address开始。

Parameters

• size – [in] 位于base_address处的缓冲区大小（以字节为单位）。

• base_address – [in] 从中分配缓冲区的地址。不获取此缓冲区的所有权，因此它必须在 MemoryAllocator 的整个生命周期内有效。

inline virtual void *allocate(size_t size, size_t alignment = kDefaultAlignment)

分配 size 字节的内存。

Parameters

• size – [输入] 要分配的字节数。

• 对齐 – [输入] 返回指针的最小对齐要求。必须是 2 的幂。

Return values

nullptr – 内存不足，或 alignment 不是 2 的幂。

Returns

成功时返回指向已分配内存的对齐指针。

template<typename T>
inline T *allocateInstance(size_t alignment = alignof(T))

为类型 T 的实例分配足够大的缓冲区。注意，内存不会被初始化。

Example:

auto p = memory_allocator->allocateInstance<MyType>();

Parameters

alignment – [in] 返回指针的最小对齐要求。必须是 2 的幂。默认为 T 的自然对齐。

Return values

nullptr – 内存不足，或 alignment 不是 2 的幂。

Returns

成功时返回指向已分配内存的对齐指针。

template<typename T>
inline T *allocateList(size_t size, size_t alignment = alignof(T))

分配 size 个类型为 T 的块，其中每个块的大小等于 sizeof(T) 字节。

Parameters

• size – [输入] 要分配的内存块数量。

• alignment – [in] 返回指针的最小对齐要求。必须是 2 的幂。默认为 T 的自然对齐。

Return values

nullptr – 内存不足，或 alignment 不是 2 的幂。

Returns

成功时返回指向已分配内存的对齐指针。

公共静态属性

static constexpr size_t kDefaultAlignment = alignof(void*)

此类返回内存的默认对齐方式。确保结构体的指针字段将对齐。然而，具体取决于工具链和架构，像long double这样的大型类型可能无法对齐。

class HierarchicalAllocator

一组可用于表示设备内存层级的缓冲区。

公共函数

inline explicit HierarchicalAllocator(Span<Span<uint8_t>> buffers)

使用给定的缓冲区数组构建一个新的分层分配器。

• 内存 ID 基于对 buffers 的索引：buffers[N] 将具有 N 的内存 ID。

• buffers.size() 必须 >= MethodMeta::num_non_const_buffers()。

• buffers[N].size() 必须 >= MethodMeta::non_const_buffer_size(N)。

inline ET_DEPRECATED HierarchicalAllocator(uint32_t n_allocators, MemoryAllocator *allocators)

已弃用：请使用 span 替代。

inline ET_NODISCARD Result< void * > get_offset_address (uint32_t memory_id, size_t offset_bytes, size_t size_bytes)

返回给定缓冲区基地址处字节偏移量为offset_bytes的地址，该地址指向至少size_bytes字节的内存。

Parameters

• memory_id – [in] 层次结构中缓冲区的 ID。

• offset_bytes – [in] 指定缓冲区中的字节偏移量。

• size_bytes – [in] 偏移处应可用的内存量。

Returns

成功时，返回指定缓冲区中请求字节偏移量的地址；失败时，返回一个非 Ok 的错误。

class MemoryManager

A container class for allocators used during 方法 load and execution.

此类整合了 方法 加载和执行的所有动态内存需求。这可以允许基于堆的执行以及无堆执行（与某些嵌入式场景相关），并且总体上提供了对内存使用的更多控制。

然而，此类无法确保所有内存分配都被计入，因为内核和后端实现可以自由采用其他方式分配内存（例如用于临时空间等）。但我们建议后端和内核在可能的情况下使用这些提供的分配器。

公共函数

inline explicit MemoryManager(MemoryAllocator *method_allocator, HierarchicalAllocator *planned_memory = nullptr, MemoryAllocator *temp_allocator = nullptr)

构造一个新的 MemoryManager。

Parameters

• method_allocator – [in] 在加载Method并分配其内部结构时要使用的分配器。其生命周期必须长于使用它的Method。

• planned_memory – [in] 在执行Method时，用于可变张量数据的内存规划缓冲区。其生命周期必须长于使用它的Method。如果该Method不使用任何内存规划的张量数据，则可为nullptr。此HierarchicalAllocator中缓冲区的大小必须与嵌入在Program中的相应MethodMeta::num_memory_planned_buffers()和MethodMeta::memory_planned_buffer_size(N)值一致。

• temp_allocator – [in] 在内核或委托执行期间分配临时数据时要使用的分配器。其生命周期必须长于使用它的Method。如果该Method不使用会分配临时数据的内核或委托，则可为nullptr。此分配器将在每次内核或委托调用后重置。

inline ET_DEPRECATED MemoryManager(MemoryAllocator *constant_allocator, HierarchicalAllocator *non_constant_allocator, MemoryAllocator *runtime_allocator, MemoryAllocator *temporary_allocator)

已弃用：请使用不带 constant_allocator 的构造函数。

TODO(T162089316)：待所有用户迁移至新的构造函数后，移除此项。

inline MemoryAllocator *method_allocator() const

返回运行时将用于在加载方法时分配内部结构的分配器。在其关联的方法加载后，不得再使用该分配器。

inline HierarchicalAllocator *planned_memory() const

返回用于可变张量数据的内存规划缓冲区。

inline MemoryAllocator *temp_allocator() const

返回在内核或委托执行期间用于分配临时数据的分配器。

此分配器将在执行期间每次内核或委托调用后重置。

值

struct EValue

公共函数

inline EValue(executorch::aten::Scalar s)

使用标量的隐式值构造一个 EValue。

template<typename T>
inline executorch::aten::optional<T> toOptional() const

将 EValue 转换为一个可选对象，该对象可以表示 T 类型以及未初始化状态。

union Payload

union TriviallyCopyablePayload

class Tensor

一个最小化的 Tensor 类型，其 API 是 at::Tensor 的源代码兼容子集。

注意：此类实例不拥有传递给它的 TensorImpl，这意味着调用者必须保证 TensorImpl 的生命周期长于任何指向它的 Tensor 实例。

有关此处使用的返回/参数类型及其与 at::Tensor 的关系，请参阅 TensorImpl 文档。

公共类型

using SizesType = TensorImpl::SizesType

用于 sizes() 元素的类型。

using DimOrderType = TensorImpl::DimOrderType

用于 dim_order() 元素的类型。

using StridesType = TensorImpl::StridesType

用于 strides() 元素的类型。

公共函数

inline TensorImpl *unsafeGetTensorImpl() const

返回指向底层 TensorImpl 的指针。

注意：客户端应谨慎直接操作 TensorImpl，而不是 Tensor。这样做很容易导致问题。

inline size_t nbytes() const

返回张量的字节大小。

注意：仅返回已使用的空间，而非底层数据块的总容量。

inline ssize_t size(ssize_t dim) const

返回张量在给定维度上的大小。

注意：size() 有意不返回 SizeType，即使它返回的是 SizeType 数组中的一个元素。这是为了使该方法的调用与 at::Tensor 更兼容，并与该类及 ETensor 中的其他方法保持一致。

inline ssize_t dim() const

返回张量的维度数。

inline ssize_t numel() const

返回张量中的元素数量。

inline ScalarType scalar_type() const

返回张量中元素的类型（int32、float、bool 等）。

inline ssize_t element_size() const

返回张量中单个元素的字节大小。

inline const ArrayRef<SizesType> sizes() const

返回张量在每个维度上的大小。

inline const ArrayRef<DimOrderType> dim_order() const

返回维度在内存中的布局顺序。

inline const ArrayRef<StridesType> strides() const

返回张量在每个维度上的步长。

inline TensorShapeDynamism shape_dynamism() const

返回张量形状的可变性。

template<typename T>
inline const T *const_data_ptr() const

返回指向常量底层数据块的类型 T 指针。

inline const void *const_data_ptr() const

返回指向底层常量数据块的指针。

template<typename T>
inline T *mutable_data_ptr() const

返回指向可变底层数据块的类型 T 指针。

inline void *mutable_data_ptr() const

返回指向可变底层数据块的指针。

template<typename T> inline ET_DEPRECATED T * data_ptr () const

已弃用：请使用 const_data_ptr 或 mutable_data_ptr。

inline ET_DEPRECATED void * data_ptr () const

已弃用：请使用 const_data_ptr 或 mutable_data_ptr。

inline ET_DEPRECATED void set_data (void *ptr) const

已弃用：更改张量别名所指向的数据指针。不会释放先前指向的数据，也不假设新指针的所有权语义。此 API 在 at::Tensor 中不存在，因此内核开发者应避免使用它。