检查器 API¶

概述¶

检查器 API 为分析 ETRecord 和 ETDump 的内容提供了一个方便的接口，帮助开发人员深入了解模型架构和性能统计信息。它建立在 EventBlock 类数据结构之上，该结构组织了一组 Event，以便轻松访问性能事件的详细信息。

用户可以通过多种方式与检查器 API 交互

通过使用 Inspector 类提供的公共方法。
通过访问 Inspector、EventBlock 和 Event 类的公共属性。
通过使用 CLI 工具实现基本功能。

请参考端到端用例文档，了解如何在实际示例中使用它们。

检查器方法¶

构造函数¶

executorch.devtools.Inspector.__init__(self, etdump_path=None, etrecord=None, source_time_scale=TimeScale.NS, target_time_scale=TimeScale.MS, debug_buffer_path=None, delegate_metadata_parser=None, delegate_time_scale_converter=None, enable_module_hierarchy=False)¶

使用来自提供的 ETDump 路径和可选的 ETRecord 路径的数据填充底层 EventBlock 来初始化一个 Inspector 实例。

参数

etdump_path – ETDump 文件的路径。
etrecord – 可选的 ETRecord 对象或 ETRecord 文件的路径。
source_time_scale – 从运行时检索的性能数据的时标。运行时中的默认时间钩子实现返回 NS。
target_time_scale – 用户希望将性能数据转换到的目标时标。默认值为 MS。
debug_buffer_path – 调试缓冲区文件路径，其中包含 ETDump 引用的用于中间输出和程序输出的调试数据。
delegate_metadata_parser – 可选的函数，用于从性能事件中解析委托元数据。函数的预期签名为：(delegate_metadata_list: List[bytes]) -> Union[List[str], Dict[str, Any]]
delegate_time_scale_converter – 可选的函数，用于转换委托性能数据的时标。如果未给出，则使用 target_time_scale/source_time_scale 的转换比率。
enable_module_hierarchy – 在运算符图中启用子模块。默认为 False。

返回值

无

示例用法

from executorch.devtools import Inspector

inspector = Inspector(etdump_path="/path/to/etdump.etdp", etrecord="/path/to/etrecord.bin")

to_dataframe¶

executorch.devtools.Inspector.to_dataframe(self, include_units=True, include_delegate_debug_data=False)¶

参数

include_units – 标头是否应包含单位（默认为 true）
include_delegate_debug_data – 是否包含委托调试元数据（默认为 false）

返回值

返回检查器中每个 EventBlock 中事件的 pandas DataFrame，其中每行表示一个事件。

print_data_tabular¶

executorch.devtools.Inspector.print_data_tabular(self, file=<sphinx_gallery.gen_rst._LoggingTee object>, include_units=True, include_delegate_debug_data=False)¶

以结构化的表格格式显示底层 EventBlock，每行代表一个事件。

参数

file – 要打印到的 IO 流。默认值为标准输出。如果在 Jupyter Notebook 等 IPython 环境中，则不使用此参数。
include_units – 标头是否应包含单位（默认为 true）
include_delegate_debug_data – 是否包含委托调试元数据（默认为 false）

返回值

无

示例用法

inspector.print_data_tabular()

请注意，委托配置文件事件的单位为“周期”。我们正在努力在未来提供一种设置不同单位的方法。

find_total_for_module¶

executorch.devtools.Inspector.find_total_for_module(self, module_name)¶

返回指定模块中所有操作符的总平均计算时间。

参数: module_name – 要聚合的模块名称。
返回值: 具有“module_name”的模块中所有操作符的平均计算时间（以秒为单位）之和。

示例用法

print(inspector.find_total_for_module("L__self___conv_layer"))

0.002

get_exported_program¶

executorch.devtools.Inspector.get_exported_program(self, graph=None)¶

ETRecord 的访问助手，默认情况下返回 Edge Dialect 程序。

参数: graph – 要访问的图的可选名称。如果为 None，则返回 Edge Dialect 程序。
返回值: “graph”的 ExportedProgram 对象。

示例用法

print(inspector.get_exported_program())

ExportedProgram:
    class GraphModule(torch.nn.Module):
        def forward(self, arg0_1: f32[4, 3, 64, 64]):
            # No stacktrace found for following nodes
            _param_constant0 = self._param_constant0
            _param_constant1 = self._param_constant1

            ### ... Omit part of the program for documentation readability ... ###

Graph signature: ExportGraphSignature(parameters=[], buffers=[], user_inputs=['arg0_1'], user_outputs=['aten_tan_default'], inputs_to_parameters={}, inputs_to_buffers={}, buffers_to_mutate={}, backward_signature=None, assertion_dep_token=None)
Range constraints: {}
Equality constraints: []

Inspector 属性¶

`EventBlock` 类¶

通过 Inspector 实例的 event_blocks 属性访问 EventBlock 实例，例如

inspector.event_blocks

class executorch.devtools.inspector.EventBlock(name, events=<factory>, source_time_scale=TimeScale.NS, target_time_scale=TimeScale.MS, bundled_input_index=None, run_output=None, reference_output=None)[source]¶

一个 EventBlock 包含与从运行时检索的特定性能分析/调试块相关联的事件集合。每个 EventBlock 代表一个执行模式。例如，模型初始化和加载位于单个 EventBlock 中。如果存在控制流，则每个分支将由一个单独的 EventBlock 表示。

参数

name – 性能分析/调试块的名称。
events – 与性能分析/调试块关联的 Event 列表。
bundled_input_idx – 此 EventBlock 对应的 Bundled Input 的索引。
run_output – 从封装的事件中提取的运行输出

`Event` 类¶

通过 EventBlock 实例的 events 属性访问 Event 实例。

class executorch.devtools.inspector.Event(name, perf_data=None, op_types=<factory>, delegate_debug_identifier=None, debug_handles=None, stack_traces=<factory>, module_hierarchy=<factory>, is_delegated_op=None, delegate_backend_name=None, _delegate_debug_metadatas=<factory>, debug_data=<factory>, _instruction_id=None, _delegate_metadata_parser=None, _delegate_time_scale_converter=None)[source]¶

一个事件对应于一个操作符实例，其中性能数据是从运行时检索的，其他元数据来自 ETRecord。

参数

name – 性能分析 Event 的名称，如果无性能分析事件，则为空。
perf_data – 与从运行时检索的事件关联的性能数据（可用属性：p10、p50、p90、avg、min 和 max）。
op_type – 与事件对应的操作符类型列表。
delegate_debug_identifier – 与指令 ID 结合使用的补充标识符。
debug_handles – 模型图中的调试句柄，该事件与之相关联。
stack_trace – 一个字典，将每个关联操作符的名称映射到其堆栈跟踪。
module_hierarchy – 一个字典，将每个关联操作符的名称映射到其模块层次结构。
is_delegated_op – 该事件是否被委托。
delegate_backend_name – 将该事件委托到的后端的名称。
_delegate_debug_metadatas – 字符串形式的原始委托调试元数据列表，每个性能分析事件一个。如果提供解析器，则可用作 Event.delegate_debug_metadatas，可用作 Event.raw_delegate_debug_metadatas
debug_data – 包含收集的中间数据的列表。
_instruction_id – 用于符号化的指令标识符
_delegate_metadata_parser – _delegate_debug_metadatas 的可选解析器

示例用法

for event_block in inspector.event_blocks:
    for event in event_block.events:
        if event.name == "Method::execute":
            print(event.perf_data.raw)

[175.748, 78.678, 70.429, 122.006, 97.495, 67.603, 70.2, 90.139, 66.344, 64.575, 134.135, 93.85, 74.593, 83.929, 75.859, 73.909, 66.461, 72.102, 84.142, 77.774, 70.038, 80.246, 59.134, 68.496, 67.496, 100.491, 81.162, 74.53, 70.709, 77.112, 59.775, 79.674, 67.54, 79.52, 66.753, 70.425, 71.703, 81.373, 72.306, 72.404, 94.497, 77.588, 79.835, 68.597, 71.237, 88.528, 71.884, 74.047, 81.513, 76.116]

CLI¶

在您的终端中执行以下命令以显示数据表。此命令产生与之前提到的 print_data_tabular 相同的表输出

python3 -m devtools.inspector.inspector_cli --etdump_path <path_to_etdump> --etrecord_path <path_to_etrecord>

请注意，etrecord_path 参数是可选的。

我们计划在未来扩展 CLI 的功能。

检查器 API¶

概述¶

检查器方法¶

构造函数¶

to_dataframe¶

print_data_tabular¶

find_total_for_module¶

get_exported_program¶

Inspector 属性¶

`EventBlock` 类¶

`Event` 类¶

CLI¶

文档

教程

资源

检查器 API¶

概述¶

检查器方法¶

构造函数¶

to_dataframe¶

print_data_tabular¶

find_total_for_module¶

get_exported_program¶

Inspector 属性¶

EventBlock 类¶

Event 类¶

CLI¶

文档

教程

资源

`EventBlock` 类¶

`Event` 类¶