ExecuTorch 运行时 API 参考

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

有关运行时 API 的教程式介绍，请查看 运行时 API 教程。

模型加载和执行

class DataLoader

从数据源加载。

请参阅 //executorch/util 获取常见实现。

公共函数

virtual __ET_NODISCARD Result< FreeableBuffer > Load (size_t offset, size_t size)=0

从底层数据源的字节偏移量 offset 加载 size 字节到 FreeableBuffer 中，该缓冲区拥有内存。

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

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

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

class MemoryAllocator

一个基于大小进行简单分配并返回内存地址指针的类。它用特定大小的缓冲区添加书签。分配只是检查空间，并在每次分配请求时增长 cur_ 指针。

简单示例

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

在幕后，ExecuTorch 会调用 allocator.allocate() 来持续迭代 cur_ 指针。

公共函数

inline MemoryAllocator(uint32_t size, uint8_t *base_address)

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

参数

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

• base_address – [in] 要从中分配的缓冲区。不拥有此缓冲区的控制权，因此它必须在 MemoryAllocator 的生命周期内有效。

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

分配 size 字节的内存。

参数

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

• alignment – [in] 返回指针的最小对齐方式。必须是 2 的幂。

返回值

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

返回值

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

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

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

示例

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

参数

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

返回值

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

返回值

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

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

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

参数

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

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

返回值

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

返回值

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

公共静态属性

static constexpr size_t kDefaultAlignment = alignof(void*)

此类返回的内存的默认对齐方式。确保结构体中的指针字段对齐。但是，较大的类型，如 long double，可能不会对齐，具体取决于工具链和体系结构。

class HierarchicalAllocator

一组缓冲区，可用于表示设备的内存层次结构。

公共函数

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

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

• 内存 ID 基于 buffers 中的索引：buffers[N] 的内存 ID 为 N。

• 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)

已弃用：请使用跨度代替。

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

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

参数

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

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

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

返回值

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

class MemoryManager

在 Method 加载和执行期间使用的分配器的容器类。

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

但是，此类无法确保所有分配都被考虑在内，因为内核和后端实现可以自由地使用单独的方式来分配内存（例如，用于诸如暂存空间之类的东西）。但我们建议后端和内核尽可能使用这些提供的分配器。

公共函数

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

构造一个新的 MemoryManager。

参数

• method_allocator – [in] 加载 Method 和分配其内部结构时要使用的分配器。必须比使用它的 Method 存活时间更长。

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

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

inline __ET_DEPRECATED MemoryManager(__attribute__((unused)) MemoryAllocator *constant_allocator, HierarchicalAllocator *non_constant_allocator, MemoryAllocator *runtime_allocator, MemoryAllocator *temporary_allocator)

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

TODO(T162089316): 所有用户迁移到新的构造函数后，删除此项。

inline MemoryAllocator *method_allocator() const

返回运行时在加载 Method 时用于分配内部结构的分配器。在关联的 Method 加载后，不得使用此分配器。

inline HierarchicalAllocator *planned_memory() const

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

inline MemoryAllocator *temp_allocator() const

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

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

class Program

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

公共类型

enum class Verification : uint8_t

Program 可以执行的数据解析前的验证类型。

值

enumerator Minimal

对数据进行最小的验证，确保标头看起来正确。

运行时开销最小。

枚举器 InternalConsistency

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

运行时开销较高，随程序数据的复杂性而变化。

枚举 HeaderStatus

描述 ExecuTorch 程序头部的存在。

值

枚举器 CompatibleVersion

存在 ExecuTorch 程序头部，并且其版本与该版本的运行时兼容。

枚举器 IncompatibleVersion

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

枚举器 NotPresent

ExecuTorch 程序头不存在。

枚举器 ShortData

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

公共函数

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

获取 Program 中索引为 buffer_idx 的常量缓冲区。

参数

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

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

返回值

具有相应索引的缓冲区。

size_t num_methods() const

返回程序中的方法数量。

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

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

参数

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

返回值

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

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

加载命名方法并准备执行。

参数

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

• memory_manager – [in] 在初始化和执行加载方法期间使用的分配器。

• event_tracer – [in] 用于此方法运行的事件跟踪器。

返回值

成功时加载的方法，或失败时的错误。

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

收集指定方法的元数据。

参数

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

__ET_DEPRECATED Result< int64_t > get_non_const_buffer_size (size_t buffer_index, const char *method_name="forward") const

已弃用：请使用 MethodMeta 代替。

获取索引为 buffer_index 的缓冲区的大小。注意，此函数不会返回索引 0 的正确值，索引 0 表示常量内存。只有索引 >= 1 才能用于检索非常量池的大小。

参数

• buffer_index – [in] 非常量缓冲区列表中的缓冲区索引

• method_name – [in] 要检索缓冲区信息的函数名称。

返回值

与 buffer_index 对应的非常量缓冲区的大小，如果无法检索则返回 Error。

__ET_DEPRECATED Result< size_t > num_non_const_buffers (const char *method_name="forward") const

已弃用：请使用 MethodMeta 代替。

获取非常量缓冲区的数量。

参数

method_name – [in] 要获取缓冲区数量的函数名称。

返回值

非常量缓冲区的数量，如果无法检索则返回 Error。

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

已弃用：获取输出的 pytree 编码字符串。已弃用，因为此功能最终将从核心程序移到更高级别的结构中，但目前尚不存在。

参数

method_name – [in] 要获取编码的函数名称。

返回值

输出的 pytree 编码字符串

公共静态函数

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

从提供的加载器加载一个 Program。该 Program 将持有指向加载器的指针，该指针必须比返回的 Program 实例存活更久。

参数

• loader – [in] 加载程序数据的源。该 Program 将持有指向此加载器的指针，该指针必须比返回的 Program 实例存活更久。

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

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 程序头。

参数

• data – [in] 来自可能包含 ExecuTorch 程序的文件开头的數據。

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

返回值

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

公共静态属性

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)

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

参数

• input_evalue – [in] 要复制到方法输入的 evalue。如果 evalue 是张量，则大多数情况下数据会被复制，因此这里传入的张量并不总是需要比此调用持续更长时间。但是，有一种情况是 Method 会保留指向张量数据的指针。根据方法的内存计划，输入可能没有为它们预先分配缓冲区空间。在这种情况下，执行器将对这里提供的作为输入的张量的内存进行别名，而不是将输入深拷贝到内存计划的竞技场中。

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

返回值

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

__ET_NODISCARD Error set_inputs (const exec_aten::ArrayRef< EValue > &input_evalues)

设置所有方法输入的值。

有关行为的更详细说明，请参见 set_input()。

参数

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

返回值

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

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

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

注意：根据方法的内存计划，输出张量可能没有为它们预先分配缓冲区空间，在这种情况下，执行器将这些张量指向此处提供的缓冲区，因此用户应注意此内存的生存期超过执行器转发。

参数

• buffer – [in] 要指向指定张量的内存块。

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

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

返回值

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

__ET_NODISCARD Error get_outputs (EValue *output_evalues, size_t length)

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

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

TODO(T139259264): 添加检查以检测输出变异，或深度复制输出。

参数

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

• length – [in] output_evalues 数组中元素的大小。必须大于或等于 outputs_size()。

返回值

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

__ET_NODISCARD Error execute ()

执行方法。

注意：如果方法已使用 experimental_step() api 部分执行，则会失败。

返回值

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

__ET_NODISCARD Error experimental_step ()

推进/执行方法中的单个指令。

注意：原型 API；可能会发生变化。

返回值

• Error::Ok – 步进成功

• 非 Ok – 步进失败

• Error::EndOfMethod – 方法已成功执行完毕

__ET_NODISCARD Error experimental_reset_execution ()

将执行状态重置为 Method 的开头。用于 experimental_step() API。

注意：原型 API；可能会发生变化。

返回值

• Error:Ok – 成功

• Error::InvalidState – 如果在基于步进的执行到达 Method 的末尾之前调用。这意味着无法恢复执行过程中失败的 Method。

MethodMeta method_meta() const

返回对应于调用 Method 的 MethodMeta。

size_t inputs_size() const

返回 Method 预期的输入数量。

size_t outputs_size() const

返回 Method 返回的输出数量。

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

获取此方法的名称。

返回值

方法名称。

size_t num_inputs() const

获取该方法的输入数量。

返回值

输入的数量。

Result<Tag> input_tag(size_t index) const

获取指定输入的标签。

参数

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

返回值

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

Result<TensorInfo> input_tensor_meta(size_t index) const

获取有关指定输入的元数据。

参数

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

返回值

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

size_t num_outputs() const

获取此方法的输出数量。

返回值

输出的数量。

Result<Tag> output_tag(size_t index) const

获取指定输出的标签。

参数

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

返回值

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

Result<TensorInfo> output_tensor_meta(size_t index) const

获取有关指定输出的元数据。

参数

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

返回值

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

size_t num_memory_planned_buffers() const

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

返回值

内存计划缓冲区的数量。

Result<int64_t> memory_planned_buffer_size(size_t index) const

获取指定内存规划缓冲区的字节大小。

参数

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

返回值

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

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()。

值

struct EValue

公共函数

inline EValue(exec_aten::Scalar s)

使用 Scalar 的隐式值构造 EValue。

template<typename T>
inline exec_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

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

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

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