torch.profiler#

创建于：2020年12月18日 | 最后更新于：2025年6月13日

概述#

PyTorch 分析器是一个工具，允许在训练和推理期间收集性能指标。分析器的上下文管理器 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, acc_events=False, custom_trace_id_callback=None)[source]#

低级分析器封装了 autograd 分析器

参数

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 的 forward 包含了 aten::add 操作符，那么 aten::add 的模块层次结构是 A.B。请注意，目前此支持仅适用于 TorchScript 模型，而不适用于即时模式模型。
experimental_config (_ExperimentalConfig) – Kineto 等分析器库使用的一组实验性选项。请注意，不保证向后兼容性。
execution_trace_observer (ExecutionTraceObserver) – 一个 PyTorch 执行轨迹观察器对象。PyTorch 执行轨迹提供了 AI/ML 工作负载的基于图的表示，并支持重放基准测试、模拟器和仿真器。当包含此参数时，观察器的 start() 和 stop() 将与 PyTorch 分析器在同一时间窗口内调用。
acc_events (bool) – 启用跨多个分析周期的 FunctionEvent 累积

注意

此 API 为实验性 API，未来可能会发生变化。

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

add_metadata(key, value)[source]#

向跟踪文件添加具有字符串键和字符串值的用户定义元数据

add_metadata_json(key, value)[source]#

向跟踪文件添加具有字符串键和有效 json 值的用户定义元数据

events()[source]#: 返回未聚合的分析器事件列表，用于跟踪回调或分析完成后使用

export_chrome_trace(path)[source]#

以 Chrome JSON 格式导出收集到的跟踪信息。如果 kineto 已启用，则仅导出调度中的最后一个周期。

export_memory_timeline(path, device=None)[source]#

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

对于 HTML 兼容图，使用后缀 .html，内存时间轴图将作为 PNG 文件嵌入到 HTML 文件中。
对于由 [times, [sizes by category]] 组成的情节点，其中 times 是时间戳，sizes 是每个类别的内存使用量。内存时间线图将根据后缀保存为 JSON (.json) 或 gzip 压缩的 JSON (.json.gz)。
对于原始内存点，请使用后缀 .raw.json.gz。每个原始内存事件将由 (timestamp, action, numbytes, category) 组成，其中 action 是 [PREEXISTING, CREATE, INCREMENT_VERSION, DESTROY] 之一，category 是 torch.profiler._memory_profiler.Category 中的枚举之一。

输出：内存时间线以 gzip 压缩的 JSON、JSON 或 HTML 格式写入。

export_stacks(path, metric='self_cpu_time_total')[source]#

将堆栈跟踪保存到文件

参数

path (str) – 将堆栈文件保存到此位置；
metric (str) – 要使用的指标：“self_cpu_time_total”或“self_cuda_time_total”

key_averages(group_by_input_shape=False, group_by_stack_n=0, group_by_overload_name=False)[source]#

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

注意

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

preset_metadata_json(key, value)[source]#

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

toggle_collection_dynamic(enable, activities)[source]#

在收集的任何时间点打开/关闭活动的收集。目前支持在 Kineto 中切换 Torch Ops (CPU) 和 CUDA 活动

参数: activities (iterable) – 用于分析的活动组列表，支持的值：torch.profiler.ProfilerActivity.CPU, torch.profiler.ProfilerActivity.CUDA

示例

with torch.profiler.profile(
    activities=[
        torch.profiler.ProfilerActivity.CPU,
        torch.profiler.ProfilerActivity.CUDA,
    ]
) as p:
    code_to_profile_0()
    // turn off collection of all CUDA activity
    p.toggle_collection_dynamic(False, [torch.profiler.ProfilerActivity.CUDA])
    code_to_profile_1()
    // turn on collection of all CUDA activity
    p.toggle_collection_dynamic(True, [torch.profiler.ProfilerActivity.CUDA])
    code_to_profile_2()
print(p.key_averages().table(
    sort_by="self_cuda_time_total", row_limit=-1))

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, acc_events=False, use_cuda=None, custom_trace_id_callback=None)[source]#

分析器上下文管理器。

参数

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 的 forward 包含了 aten::add 操作符，那么 aten::add 的模块层次结构是 A.B。请注意，目前此支持仅适用于 TorchScript 模型，而不适用于即时模式模型。
experimental_config (_ExperimentalConfig) – 用于 Kineto 库功能的一组实验选项。请注意，不保证向后兼容性。
execution_trace_observer (ExecutionTraceObserver) – 一个 PyTorch 执行跟踪观察器对象。PyTorch 执行跟踪提供 AI/ML 工作负载的基于图的表示，并支持回放基准测试、模拟器和仿真器。当包含此参数时，观察器的 start() 和 stop() 将在与 PyTorch 分析器相同的时间窗口内调用。请参阅下面的示例部分以获取代码示例。
acc_events (bool) – 启用跨多个分析周期的 FunctionEvent 累积
use_cuda (bool) –

自 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 插件

注意

示例

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 接口的对象。

get_trace_id()[source]#: 返回当前跟踪 ID。

set_custom_trace_id_callback(callback)[source]#: 设置在生成新跟踪 ID 时要调用的回调。

step()[source]#: 向分析器发出信号，表示下一个分析步骤已开始。

class torch.profiler.ProfilerAction(value)[source]#: 可以在指定时间间隔内执行的分析器操作

class torch.profiler.ProfilerActivity#

成员

CPU

XPU

MTIA

CUDA

HPU

PrivateUse1

property name#

torch.profiler.schedule(*, wait, warmup, active, repeat=0, skip_first=0, skip_first_wait=0)[source]#

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

skip_first_wait 参数控制是否应跳过第一个 wait 阶段。如果用户希望等待比 skip_first 更长的时间，但对于第一次分析则不然，这可能会很有用。例如，如果 skip_first 为 10 且 wait 为 20，则如果 skip_first_wait 为零，则第一个循环将在热身前等待 10 + 20 = 30 步，但如果 skip_first_wait 为非零，则仅等待 10 步。所有后续循环将在上一次活动和热身之间等待 20 步。

返回类型: 可调用对象

torch.profiler.tensorboard_trace_handler(dir_name, worker_name=None, use_gzip=False)[source]#

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

英特尔仪器和跟踪技术 API#

torch.profiler.itt.is_available()[source]#: 检查 ITT 功能是否可用

torch.profiler.itt.mark(msg)[source]#

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

参数: msg (str) – 与事件关联的 ASCII 消息。

torch.profiler.itt.range_push(msg)[source]#

将范围推送到嵌套范围跨度堆栈中。返回开始范围的基于零的深度。

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

torch.profiler.itt.range_pop()[source]#: 从嵌套范围跨度堆栈中弹出一个范围。返回已结束范围的基于零的深度。

torch.profiler#

概述#

API 参考#

英特尔仪器和跟踪技术 API#

文档

教程

资源