torch_npu.profiler.profile

产品支持情况

功能说明

提供PyTorch训练过程中的性能数据采集功能。

函数原型

参数说明

• activities (enum)：可选参数，CPU、NPU事件采集列表。可取值以及含义详见。

• schedule (callable)：可选参数，设置不同step的行为。由控制。默认不执行任何操作。

• on_trace_ready (callable)：可选参数，采集结束时自动执行操作。当前仅支持执行的操作，默认不执行任何操作。

• record_shapes (bool)：可选参数，算子的InputShapes和InputTypes。取值为：

  • True：开启。
  • False：关闭。

  默认值为False。

  开启torch_npu.profiler.ProfilerActivity.CPU时生效。

• profile_memory (bool)：可选参数，算子的内存占用情况。取值为：

  • True：开启。
  • False：关闭。

  默认值为False。

  说明： 已知在安装有glibc<2.34的环境上采集memory数据，可能触发glibc的一个已知，通过升级环境的glibc版本可解决此问题。

• with_stack (bool)：可选参数，算子调用栈。包括框架层及CPU算子层的调用信息。取值为：

  • True：开启。
  • False：关闭。

  默认值为False。

  开启torch_npu.profiler.ProfilerActivity.CPU时生效。

• with_modules (bool)：可选参数，modules层级的Python调用栈，即框架层的调用信息。取值为：

  • True：开启。
  • False：关闭。

  默认值为False。

  开启torch_npu.profiler.ProfilerActivity.CPU时生效。

• with_flops (bool)：可选参数，算子浮点操作（该参数暂不支持解析性能数据）。取值为：

  • True：开启。
  • False：关闭。

  默认值为False。

  开启torch_npu.profiler.ProfilerActivity.CPU时生效。

• experimental_config：可选参数，扩展参数，通过扩展配置性能分析工具常用的采集项。支持采集项和详细介绍请参见。

• use_cuda (bool)：可选参数，昇腾环境不支持。开启采集cuda性能数据开关。取值为：

  • True：开启。
  • False：关闭。默认值。

  torch_npu.profiler._KinetoProfile不支持该参数。

返回值说明

无

调用示例

以下是关键步骤的代码示例，不可直接拷贝编译运行，仅供参考。