ProfilingConfig构造函数

函数原型

def __init__(self,

enable_profiling=False,

profiling_options=None

)

功能说明

ProfilingConfig类的构造函数，用于配置Profiling功能。

参数说明

参数名

输入/输出

描述

enable_profiling

输入

是否开启Profiling功能。

  • True：开启Profiling功能，从profiling_options读取Profiling的采集选项。
  • False：关闭Profiling功能，默认关闭。

profiling_options

输入

Profiling配置选项。

  • output：Profiling采集结果文件保存路径。该参数指定的目录需要在启动训练的环境上（容器或Host侧）提前创建且确保安装时配置的运行用户具有读写权限，支持配置绝对路径或相对路径（相对执行命令行时的当前路径）。
    • 绝对路径配置以“/”开头，例如：/home/HwHiAiUser/output。
    • 相对路径配置直接以目录名开始，例如：output。
  • storage_limit：指定落盘目录允许存放的最大文件容量。当Profiling数据文件在磁盘中即将占满本参数设置的最大存储空间（剩余空间<=20MB）或剩余磁盘总空间即将被占满时（总空间剩余<=20MB），则将磁盘内最早的文件进行老化删除处理。

    单位为MB，有效取值范围为[200, 4294967296]，默认未配置本参数。

    参数值配置格式为数值+单位，例如"storage_limit": "200MB"。

    未配置本参数时，默认取值为Profiling数据文件存放目录所在磁盘可用空间的90%。

  • training_trace：采集迭代轨迹数据，即训练任务及AI软件栈的软件信息，实现对训练任务的性能分析，重点关注数据增强、前后向计算、梯度聚合更新等相关数据。为非必选项配置，用户可不配置，当用户配置时必须设为“on”。
  • task_trace：采集任务轨迹数据，即昇腾AI处理器HWTS，分析任务开始、结束等信息。取值on/off。如果将该参数配置为“on”和“off”之外的任意值，则按配置为“off”处理。
  • hccl：控制hccl数据采集开关，可选on或off，默认为off。
  • aicpu：采集aicpu数据增强的Profiling数据。取值on/off。如果将该参数配置为“on”和“off”之外的任意值，则按配置为“off”处理。
  • fp_point：training_trace为on时需要配置。指定训练网络迭代轨迹正向算子的开始位置，用于记录前向计算开始时间戳。配置值为指定的正向第一个算子名字。用户可以在训练脚本中，通过tf.io.write_graph将graph保存成.pbtxt文件，并获取文件中的name名称填入。
  • bp_point：training_trace为on时需要配置。指定训练网络迭代轨迹反向算子的结束位置，记录后向计算结束时间戳，fp_point和bp_point可以计算出正反向时间。配置值为指定的反向最后一个算子名字。用户可以在训练脚本中，通过tf.io.write_graph将graph保存成.pbtxt文件，并获取文件中的name名称填入。
  • aic_metrics：AI Core和AI Vector Core的硬件信息，取值如下：

    ArithmeticUtilization：各种计算类指标占比统计

    PipeUtilization： 计算单元和搬运单元耗时占比，该项为默认值

    Memory：外部内存读写类指令占比

    MemoryL0：内部内存读写类指令占比

    ResourceConflictRatio：流水线队列类指令占比

    L2Cache：读写cache命中次数和缺失后重新分配次数

    说明：
    支持自定义需要采集的寄存器，例如："aic_metrics":"Custom:0x49,0x8,0x15,0x1b,0x64,0x10"。
    • Custom字段表示自定义类型，配置为具体的寄存器值，取值范围为[0x1, 0x6E]。
    • 配置的寄存器数最多不能超过8个，寄存器通过“,”区分开。
    • 寄存器的值支持十六进制或十进制。
  • l2：控制L2采样数据的开关，可选on或off，默认为off。可选参数。
  • msproftx：控制msproftx用户和上层框架程序输出性能数据的开关，可选on或off，默认值为off。

    Profiling开启msproftx功能之前，需要在程序内调用msproftx相关接口来开启程序的Profiling数据流的输出，详细操作请参见《应用软件开发指南（C&C++）》“高级功能>Profiling性能数据采集”章节。

  • task_time：控制任务调度耗时以及算子耗时的开关。涉及在task_time、op_summary、op_statistic文件中输出相关耗时数据。可选on或off，默认为on。
  • runtime_api：控制runtime api性能数据采集开关，可选on或off，默认为off。可采集runtime-api性能数据，Host与Device之间、Device间的同步异步内存复制时延runtime-api性能数据。
  • sys_hardware_mem_freq：DDR、HBM（Atlas 训练系列产品支持该参数）带宽及内存信息采集频率、LLC的读写带宽数据采集频率以及acc_pmu数据和SOC传输带宽信息采集频率，范围[1,100]，默认值为50，单位hz。
  • llc_profiling：LLC Profiling采集事件，可以设置为：
    • Atlas 200/300/500 推理产品，可选capacity（采集AI CPU和Control CPU的LLC capacity数据）或bandwidth（采集LLC bandwidth），默认为capacity。
    • Atlas 推理系列产品，可选read（读事件，三级缓存读速率）或write（写事件，三级缓存写速率），默认为read。
    • Atlas 训练系列产品，可选read（读事件，三级缓存读速率）或write（写事件，三级缓存写速率），默认为read。
    • 可选read（读事件，三级缓存读速率）或write（写事件，三级缓存写速率），默认为read。
  • sys_io_sampling_freq：NIC（Atlas 200/300/500 推理产品）（Atlas 训练系列产品）、ROCE（Atlas 训练系列产品）采集频率。取值范围为[1,100]，默认值100，单位hz。
  • sys_interconnection_freq：集合通信带宽数据（HCCS，Atlas 训练系列产品）、PCIe数据（Atlas 推理系列产品）（Atlas 训练系列产品）采集频率以及片间传输带宽信息采集频率。取值范围为[1,50]，默认值50，单位hz。
  • dvpp_freq：DVPP采集频率。取值范围为[1,100]，默认值50，单位hz。
  • instr_profiling_freq：AI Core和AI Vector的带宽和延时采集频率。取值范围[300,30000]，默认值1000，单位hz。
  • host_sys：Host侧性能数据采集开关。取值包括cpu和mem，可选其中的一项或多项，选多项时用英文逗号隔开，例如"host_sys": "cpu,mem"。
  • host_sys_usage：采集Host侧系统及所有进程的CPU和内存数据。取值包括cpu和mem，可选其中的一项或多项，选多项时用英文逗号隔开。
  • host_sys_usage_freq：配置Host侧系统和所有进程CPU、内存数据的采集频率。取值范围为[1,50]，默认值50，单位hz。
说明：

instr_profiling_freq开关与training_trace、task_trace、hccl、aicpu、fp_point、bp_point、aic_metrics、l2、task_time、runtime_api互斥，无法同时执行。

配置示例： 
profiling_options = 
'{"output":"/tmp/profiling","training_trace":"on",task_trace":"on","fp_point":"","bp_point":"","aic_metrics":"PipeUtilization"}'

返回值

返回ProfilingConfig类对象，作为NPURunConfig的参数传入。

父主题： npu_bridge.estimator.npu.npu_config