委托调试¶

委托后端是设备端模型的重要组成部分，因为它们在定义行为方面具有灵活性。这种灵活性的一个副作用是它作为不透明的转换运行。这模糊了后处理中非常有价值的丰富关联和突变。

例如，如果两个不同的运算符融合发生在委托中，则后处理将无法分离这两个转换。

具体而言，这使得通过委托图关联运行时信息（例如分析结果）变得困难。委托调试标识符提供了一个框架，委托作者可以通过该框架传播此信息并将其用于运行后分析。

准备工作分为三个阶段

提前期 (AOT)：委托作者生成调试句柄映射。
运行时：委托作者使用 AOT 在调试句柄映射中注册的委托调试标识符进行日志记录。
反序列化：委托作者为委托事件中的自定义元数据提供解析器。

提前期集成¶

委托作者通过从后端实现返回调试句柄映射来传播在降低的后端中发生的转换。

生成调试句柄映射¶

调试句柄映射通过将委托调试标识符映射到调试句柄来传达后端中发生的转换。

委托调试标识符是为表示运行时期间的关注点而生成的标识符或用户提供的标识符。回想一下，调试句柄是模型图中运算符实例的唯一标识符。

例如

{ 0: (10, 11), 1: (11, 12) }: 运行时中的标识符 0 和 1 分别对应于调试句柄为 (10, 11) 和 (11, 12) 的运算符。
{ “fused_op_1_2_3”: (11, 12, 15) }：运行时中的标识符 “fused_op_1_2_3” 对应于调试句柄为 (11, 12, 15) 的运算符，而 11、12、15 对应于运算符 1、运算符 2 和运算符 3。

注意

标识符是将运行时结果连接到模型图的一种手段；标识符的解释由委托作者定义。

调试句柄映射通过使用 DelegateMappingBuilder 构建，并作为 PreprocessResult 的一部分返回。

class PreprocessResult:
    processed_bytes: bytes = bytes()

    debug_handle_map: Optional[
        Union[Dict[int, Tuple[int]], Dict[str, Tuple[int]]]
    ] = None

PreprocessResult 在此处定义。

DelegateMappingBuilder¶

DelegateMappingBuilder 是一个辅助类，用于管理和构建调试句柄映射。构建器的结果应在构建 PreprocessResult 时传入。

DelegateMappingBuilder 在此处定义

DelegateMappingBuilder 实例可以在 2 种模式之一中构建：手动标识符或生成标识符。

# Manual Identifiers, Default
builder = DelegateMappingBuilder(generated_identifiers=False)

# Generated Identifiers
builder = DelegateMappingBuilder(generated_identifiers=True)

使用手动标识符，用户在创建条目时传入委托调试标识符。使用生成标识符，构建器将自动分配委托调试标识符。

要向调试句柄映射添加条目，请使用 insert_delegate_mapping_entry。它将 fx.Node(s) 或调试句柄 (s)（源自 node.meta[“debug_handle”]）之一与可选的委托调试标识符（用于手动标识符）相关联。记录的标识符从调用中返回。

def insert_delegate_mapping_entry(
    self,
    nodes: Optional[Union[Node, List[Node]]] = None,
    handles: Optional[Union[int, List[int]]] = None,
    identifier: Optional[Union[int, str]] = None,
) -> Union[int, str]:

要检索调试句柄映射，请使用 get_delegate_mapping。

def get_delegate_mapping(
    self,
) -> Union[Dict[int, Tuple[int]], Dict[str, Tuple[int]]]

AOT 映射的演示可以在此处找到

运行时日志记录¶

与 AOT 映射相对应，运行时随后定义了记录这些事件的功能。

实时日志记录¶

ExecuTorch 允许您实时记录日志。当时间戳在执行时可用时，实时日志记录非常有用。它提供最小的开销，并且对于作者调用来说很直观。

要实时记录事件（例如，显式表示分析的开始和停止），event_tracer_start_profiling_delegate 用于创建 EventEntry，event_tracer_end_profiling_delegate 用于为提供的 EventTracer 结束 EventEntry。

要使用 event_tracer_start_profiling_delegate 启动 EventTracerEntry，请将委托调试标识符（AOT 提供给 debug_handle_map）作为名称或 delegate_debug_id 参数传递，具体取决于委托调试标识符类型（分别为 str 和 int）

EventTracerEntry event_tracer_start_profiling_delegate(
    EventTracer* event_tracer,
    const char* name,
    DebugHandle delegate_debug_id)

要结束 EventTracerEntry，只需向 event_tracer_end_profiling_delegate 提供原始 EventTracerEntry。

可选地，此时还可以记录其他运行时 metadata。

void event_tracer_end_profiling_delegate(
    EventTracer* event_tracer,
    EventTracerEntry event_tracer_entry,
    const void* metadata = nullptr,
    size_t metadata_len = 0)

后时日志记录¶

ExecuTorch 还允许您在后时记录日志。某些运行时设置在执行时无法访问时间戳。后时日志记录使作者仍然能够记录这些事件。

要记录后时事件（例如，同时记录开始时间和结束时间），请使用实时日志记录 API 中使用的参数和时间戳的组合调用 event_tracer_log_profiling_delegate。

void event_tracer_log_profiling_delegate(
    EventTracer* event_tracer,
    const char* name,
    DebugHandle delegate_debug_id,
    et_timestamp_t start_time,
    et_timestamp_t end_time,
    const void* metadata = nullptr,
    size_t metadata_len = 0)

运行时代码的演示可以在此处找到。

从委托事件中显示自定义元数据¶

如上面的运行时日志记录 API 中所示，用户可以记录字节数组以及他们的委托分析事件。我们通过 Inspector API 使这些数据可供用户在后处理中使用。

用户可以在创建 Inspector 实例时传递元数据解析器。解析器是可调用对象，它反序列化数据并返回字符串列表或包含键值对的字典。然后，反序列化的数据将添加回事件块中的相应事件以供用户使用。以下是如何编写此解析器的示例

注意：反序列化器的输入是一个列表，其中每个条目都是一系列字节（本质上每个条目都是一个不可变的 bytearray）。用户应遍历此列表，反序列化每个条目，然后以预期格式（字符串列表或字典）返回。

Inspector(
    etdump_path=etdump_path,
    # Optional
    etrecord=etrecord_path,
    # Optional, only needed if debugging was enabled.
    buffer_path=buffer_path,
    delegate_metadata_parser=parse_delegate_metadata
)


def parse_delegate_metadata(delegate_metadatas: List[bytes]) -> Union[List[str], Dict[str, Any]]:
    metadata_str = []
    for metadata_bytes in delegate_metadatas:
        metadata_str += str(metadata_bytes)
    return metadata_str