torch.profiler

概述

PyTorch Profiler 是一个工具，允许在训练和推理期间收集性能指标。Profiler 的上下文管理器 API 可用于更好地了解哪些模型运算符最昂贵，检查它们的输入形状和堆栈跟踪，研究设备内核活动并可视化执行跟踪。

注意

torch.autograd 模块中的早期版本 API 被认为是旧版，将被弃用。

API 参考

class torch.profiler._KinetoProfile(*, activities=None, record_shapes=False, profile_memory=False, with_stack=False, with_flops=False, with_modules=False, experimental_config=None, execution_trace_observer=None)

低级 Profiler 包装 autograd Profiler

参数

• activities (iterable) – 用于分析的活动组列表 (CPU、CUDA)，支持的值：torch.profiler.ProfilerActivity.CPU、torch.profiler.ProfilerActivity.CUDA、torch.profiler.ProfilerActivity.XPU。默认值：ProfilerActivity.CPU 以及（如果可用）ProfilerActivity.CUDA 或（如果可用）ProfilerActivity.XPU。

• record_shapes (bool) – 保存有关运算符的输入形状的信息。

• profile_memory (bool) – 跟踪张量内存分配/释放（有关更多详细信息，请参见 export_memory_timeline）。

• with_stack (bool) – 为运算符记录源信息（文件和行号）。

• with_flops (bool) – 使用公式来估计特定运算符的 FLOPS（矩阵乘法和二维卷积）。

• with_modules (bool) – 记录与运算符调用堆栈相对应的模块层次结构（包括函数名）。例如，如果模块 A 的 forward 调用模块 B 的 forward，而模块 B 包含 aten::add 运算符，则 aten::add 的模块层次结构为 A.B 请注意，此支持目前仅适用于 TorchScript 模型，而不适用于 Eager 模式模型。

• experimental_config (_ExperimentalConfig) – Kineto 等 Profiler 库使用的一组实验性选项。请注意，向后兼容性不受保证。

• execution_trace_observer (ExecutionTraceObserver) – PyTorch Execution Trace Observer 对象。 PyTorch Execution Traces 提供了 AI/ML 工作负载的基于图的表示，并启用了重放基准、模拟器和仿真器。包含此参数时，观察者的 start() 和 stop() 将在与 PyTorch Profiler 相同的时间窗口内被调用。

注意

此 API 处于实验阶段，将来可能会发生变化。

启用形状和堆栈跟踪会导致额外的开销。当指定 record_shapes=True 时，Profiler 将临时保存对张量的引用；这可能会进一步阻止依赖于引用计数的某些优化，并引入额外的张量复制。

add_metadata(key, value)

将用户定义的元数据（使用字符串键和字符串值）添加到跟踪文件中

add_metadata_json(key, value)

将用户定义的元数据（使用字符串键和有效的 json 值）添加到跟踪文件中

events()

返回未聚合的分析器事件列表，用于跟踪回调或分析完成后。

export_chrome_trace(path)

将收集到的跟踪以 Chrome JSON 格式导出。如果启用了 kineto，则仅导出计划中的最后一个周期。

export_memory_timeline(path, device=None)

从分析器收集的树中导出给定设备的内存事件信息，并导出时间线图。使用 export_memory_timeline 可以导出 3 个文件，每个文件都由 path 的后缀控制。

• 对于兼容 HTML 的图，使用后缀 .html，内存时间线图将作为 PNG 文件嵌入到 HTML 文件中。

• 对于由 [times, [sizes by category]] 组成的绘图点，其中 times 是时间戳，sizes 是每个类别的内存使用情况。内存时间线图将保存为 JSON (.json) 或压缩 JSON (.json.gz)，具体取决于后缀。

• 对于原始内存点，使用后缀 .raw.json.gz。每个原始内存事件将包含 (timestamp, action, numbytes, category)，其中 action 是 [PREEXISTING, CREATE, INCREMENT_VERSION, DESTROY] 中的一个，而 category 是 torch.profiler._memory_profiler.Category 中枚举类型之一。

输出：作为压缩 JSON、JSON 或 HTML 写入的内存时间线。

export_stacks(path, metric='self_cpu_time_total')

将堆栈跟踪保存到文件

参数

• path (str) – 将堆栈文件保存到此位置；

• metric (str) – 要使用的指标：“self_cpu_time_total” 或 “self_cuda_time_total”

key_averages(group_by_input_shape=False, group_by_stack_n=0)

对事件进行平均，按操作符名称和（可选）输入形状和堆栈进行分组。

注意

要使用形状/堆栈功能，请确保在创建分析器上下文管理器时设置 record_shapes/with_stack。

preset_metadata_json(key, value)

在分析器未启动时预设用户定义的元数据，并将其添加到跟踪文件中。元数据格式为字符串键和有效的 json 值

class torch.profiler.profile(*, activities=None, schedule=None, on_trace_ready=None, record_shapes=False, profile_memory=False, with_stack=False, with_flops=False, with_modules=False, experimental_config=None, execution_trace_observer=None, use_cuda=None)

分析器上下文管理器。

参数

• activities (iterable) – 用于分析的活动组列表 (CPU、CUDA)，支持的值：torch.profiler.ProfilerActivity.CPU、torch.profiler.ProfilerActivity.CUDA、torch.profiler.ProfilerActivity.XPU。默认值：ProfilerActivity.CPU 以及（如果可用）ProfilerActivity.CUDA 或（如果可用）ProfilerActivity.XPU。

• schedule (Callable) – 可调用对象，接受步骤 (int) 作为单个参数，并返回 ProfilerAction 值，该值指定在每个步骤执行的分析器操作。

• on_trace_ready (Callable) – 可调用对象，在每个步骤调用，当 schedule 在分析过程中返回 ProfilerAction.RECORD_AND_SAVE 时调用。

• record_shapes (bool) – 保存有关运算符的输入形状的信息。

• profile_memory (bool) – 跟踪张量内存分配/释放。

• with_stack (bool) – 为运算符记录源信息（文件和行号）。

• with_flops (bool) – 使用公式估计特定操作符（矩阵乘法和二维卷积）的 FLOPs（浮点运算）。

• with_modules (bool) – 记录与运算符调用堆栈相对应的模块层次结构（包括函数名）。例如，如果模块 A 的 forward 调用模块 B 的 forward，而模块 B 包含 aten::add 运算符，则 aten::add 的模块层次结构为 A.B 请注意，此支持目前仅适用于 TorchScript 模型，而不适用于 Eager 模式模型。

• experimental_config (_ExperimentalConfig) – 用于 Kineto 库功能的一组实验选项。请注意，不保证向后兼容性。

• execution_trace_observer (ExecutionTraceObserver) – PyTorch 执行跟踪观察器对象。 PyTorch 执行跟踪 提供基于图的 AI/ML 工作负载表示，并启用重放基准测试、模拟器和仿真器。当包含此参数时，观察器的 start() 和 stop() 将在与 PyTorch 分析器相同的时间窗口内调用。有关代码示例，请参见下面的示例部分。

• use_cuda (bool) –

  Deprecated since version 1.8.1: 使用 activities 代替。

注意

使用 schedule() 生成可调用的计划。当分析长时间的训练作业时，非默认计划很有用，允许用户在训练过程的不同迭代中获取多个跟踪。默认计划仅在上下文管理器的持续时间内连续记录所有事件。

注意

使用 tensorboard_trace_handler() 为 TensorBoard 生成结果文件

on_trace_ready=torch.profiler.tensorboard_trace_handler(dir_name)

分析完成后，可以在指定目录中找到结果文件。使用命令

tensorboard --logdir dir_name

在 TensorBoard 中查看结果。有关更多信息，请参见 PyTorch 分析器 TensorBoard 插件

注意

启用形状和堆栈跟踪会导致额外的开销。当指定 record_shapes=True 时，Profiler 将临时保存对张量的引用；这可能会进一步阻止依赖于引用计数的某些优化，并引入额外的张量复制。

示例

with torch.profiler.profile(
    activities=[
        torch.profiler.ProfilerActivity.CPU,
        torch.profiler.ProfilerActivity.CUDA,
    ]
) as p:
    code_to_profile()
print(p.key_averages().table(
    sort_by="self_cuda_time_total", row_limit=-1))

使用分析器的 schedule、on_trace_ready 和 step 函数

# Non-default profiler schedule allows user to turn profiler on and off
# on different iterations of the training loop;
# trace_handler is called every time a new trace becomes available
def trace_handler(prof):
    print(prof.key_averages().table(
        sort_by="self_cuda_time_total", row_limit=-1))
    # prof.export_chrome_trace("/tmp/test_trace_" + str(prof.step_num) + ".json")

with torch.profiler.profile(
    activities=[
        torch.profiler.ProfilerActivity.CPU,
        torch.profiler.ProfilerActivity.CUDA,
    ],

    # In this example with wait=1, warmup=1, active=2, repeat=1,
    # profiler will skip the first step/iteration,
    # start warming up on the second, record
    # the third and the forth iterations,
    # after which the trace will become available
    # and on_trace_ready (when set) is called;
    # the cycle repeats starting with the next step

    schedule=torch.profiler.schedule(
        wait=1,
        warmup=1,
        active=2,
        repeat=1),
    on_trace_ready=trace_handler
    # on_trace_ready=torch.profiler.tensorboard_trace_handler('./log')
    # used when outputting for tensorboard
    ) as p:
        for iter in range(N):
            code_iteration_to_profile(iter)
            # send a signal to the profiler that the next iteration has started
            p.step()

以下示例显示了如何设置执行跟踪观察器 (execution_trace_observer)

with torch.profiler.profile(
    ...
    execution_trace_observer=(
        ExecutionTraceObserver().register_callback("./execution_trace.json")
    ),
) as p:
    for iter in range(N):
        code_iteration_to_profile(iter)
        p.step()

您还可以参考 tests/profiler/test_profiler.py 中的 test_execution_trace_with_kineto()。注意：也可以传递任何满足 _ITraceObserver 接口的对象。

step()

向分析器发出信号，表明下一个分析步骤已开始。

class torch.profiler.ProfilerAction(value)

可在指定间隔执行的分析器操作

class torch.profiler.ProfilerActivity

成员

CPU

XPU

MTIA

CUDA

PrivateUse1

property name

torch.profiler.schedule(*, wait, warmup, active, repeat=0, skip_first=0)

返回一个可调用对象，可用作分析器 schedule 参数。分析器将跳过前 skip_first 步，然后等待 wait 步，然后进行 warmup 步的预热，接着进行 active 步的主动记录，然后重复该循环，从 wait 步开始。可选的循环次数由 repeat 参数指定，值为零表示循环将持续进行，直到分析结束。

返回类型

可调用对象

torch.profiler.tensorboard_trace_handler(dir_name, worker_name=None, use_gzip=False)

将跟踪文件输出到 dir_name 目录中，然后该目录可以直接作为 logdir 传递给 tensorboard。 worker_name 在分布式场景中应为每个 worker 唯一，默认情况下将设置为 ' [hostname] _ [pid]'。

英特尔仪器和跟踪技术 API

torch.profiler.itt.is_available()

检查 ITT 功能是否可用

torch.profiler.itt.mark(msg)

描述在某个时间点发生的瞬时事件。

参数

msg (str) – 与该事件关联的 ASCII 消息。

torch.profiler.itt.range_push(msg)

将一个范围推入嵌套范围跨度的堆栈。返回已启动范围的零基深度。

参数

msg (str) – 与范围关联的 ASCII 消息

torch.profiler.itt.range_pop()

从嵌套范围跨度的堆栈中弹出一个范围。返回已结束范围的零基深度。