Prerequisite | ETRecord - ExecuTorch Record¶
概述¶
ETRecord
旨在成为用户提前生成的调试工件(当他们导出模型以在 ExecuTorch 上运行时)。为了大致等同于传统的软件开发,ETRecord
可以被视为使用调试符号构建的二进制文件,该二进制文件用于 GNU 调试器 (gdb) 中的调试。预计用户将向 ExecuTorch 开发者工具提供此文件,以便他们调试和可视化其模型。
ETRecord
包含许多组件,例如
带有调试句柄的 Edge 方言图
委托调试句柄映射
ETRecord
对象本身旨在对用户不透明,他们不应直接访问其中的任何组件。应将其提供给 Inspector API,以将来自运行时的性能和调试数据链接回 Python 源代码。
生成 ETRecord
¶
用户应使用以下 API 生成 ETRecord
文件。他们将被要求提供 Edge Dialect 程序(通过调用 to_edge()
返回),ExecuTorch 程序(通过调用 to_executorch()
返回)以及他们有兴趣通过我们的工具使用的可选模型。
警告
用户应深度复制 to_edge()
的输出,并将深度副本传递给 generate_etrecord
API。这是必需的,因为后续调用 to_executorch()
会进行就地突变,并且会在此过程中丢失调试数据。
- executorch.devtools.etrecord._etrecord.generate_etrecord(et_record, edge_dialect_program, executorch_program, export_modules=None)[源代码]¶
从给定对象生成 ETRecord,对其进行序列化并将其保存到给定路径。将序列化为 ETRecord 的对象是 export_modules 字典中存在的所有图模块、边缘方言程序对象中存在的图模块以及 ExecuTorch 程序对象中存在的图模块,后者是最接近最终在设备上运行的图模块表示形式。除了所有图模块外,我们还序列化程序缓冲区,用户可以将其提供给 ExecuTorch 运行时以运行模型,以及用于开发者工具的调试句柄映射。
- 参数
et_record – ETRecord 文件将保存到的路径。
edge_dialect_program – 调用 to_edge() 返回的此模型的 EdgeProgramManager
executorch_program – 调用 to_executorch() 返回的此模型的 ExecuTorch 程序或此模型的 BundledProgram
[可选] (export_modules) – OSS 用户应忽略。图模块字典,键是用户提供的名称,值是相应的导出模块。导出的图模块可以是 torch.export() 或 exir.to_edge() 的输出。
- 返回值
无
使用 ETRecord
¶
将 ETRecord
作为可选参数传递到 Inspector API 以访问此数据并进行运行后分析。