Ascend PyTorch Profiler接口采集

约束

Ascend PyTorch Profiler接口支持多种采集方式，各采集方式不可同时开启。

前提条件

• 请确保完成使用前准备。
• 准备好基于PyTorch 1.11.0或更高版本开发的训练模型以及配套的数据集，并按照《PyTorch模型迁移和训练指南》中的“迁移适配”完成PyTorch原始模型向昇腾AI处理器的迁移。

采集并解析性能数据（torch_npu.profiler.profile）

1. 在训练脚本（如train_*.py文件）内添加如下示例代码进行性能数据采集参数配置，之后启动训练。下列示例代码中，加粗字段为需要配置的参数、方法、类和函数。
   

   以下示例代码中的torch_npu.profiler.profile接口详细介绍请参见Ascend PyTorch Profiler接口说明。

   import torch
   import torch_npu
   
   ...
   
   experimental_config = torch_npu.profiler._ExperimentalConfig(
   	export_type=torch_npu.profiler.ExportType.Text,
   	profiler_level=torch_npu.profiler.ProfilerLevel.Level0,
   	msprof_tx=False,
   	aic_metrics=torch_npu.profiler.AiCMetrics.AiCoreNone,
   	l2_cache=False,
   	op_attr=False,
   	data_simplification=False,
   	record_op_args=False,
   	gc_detect_threshold=None
   )
   
   with torch_npu.profiler.profile(
           activities=[
                   torch_npu.profiler.ProfilerActivity.CPU,
                   torch_npu.profiler.ProfilerActivity.NPU
                   ],
           schedule=torch_npu.profiler.schedule(wait=0, warmup=0, active=1, repeat=1, skip_first=1),
           on_trace_ready=torch_npu.profiler.tensorboard_trace_handler("./result"),
           record_shapes=False,
           profile_memory=False,
           with_stack=False,
           with_modules=False,
           with_flops=False,
           experimental_config=experimental_config) as prof:
                   for step in range(steps):
                          train_one_step(step, steps, train_loader, model, optimizer, criterion)
                          prof.step()

   或

   import torch
   import torch_npu
   ...
   
   experimental_config = torch_npu.profiler._ExperimentalConfig(
   	export_type=torch_npu.profiler.ExportType.Text,
   	profiler_level=torch_npu.profiler.ProfilerLevel.Level0,
   	msprof_tx=False,
   	aic_metrics=torch_npu.profiler.AiCMetrics.AiCoreNone,
   	l2_cache=False,
   	op_attr=False,
   	data_simplification=False,
   	record_op_args=False,
   	gc_detect_threshold=None
   )
   
   prof = torch_npu.profiler.profile(
          activities=[
                   torch_npu.profiler.ProfilerActivity.CPU,
                   torch_npu.profiler.ProfilerActivity.NPU
                   ],
          schedule=torch_npu.profiler.schedule(wait=0, warmup=0, active=1, repeat=1, skip_first=1),
          on_trace_ready=torch_npu.profiler.tensorboard_trace_handler("./result"),
           record_shapes=False,
           profile_memory=False,
           with_stack=False,
           with_modules=False,
           with_flops=False,
           experimental_config=experimental_config)
   prof.start()
   for step in range(steps):
            train_one_step()
            prof.step()
   prof.stop()

   除了使用tensorboard_trace_handler导出性能数据外，还可以使用以下方式导出：

   import torch
   import torch_npu
   
   ...
   
   with torch_npu.profiler.profile() as prof:
           for step in range(steps):
                   train_one_step(step, steps, train_loader, model, optimizer, criterion)
   prof.export_chrome_trace('./chrome_trace_14.json')

2. 性能数据解析。

   支持自动解析（参照以上示例代码中tensorboard_trace_handler和prof.export_chrome_trace）和离线解析。

3. 查看采集到的PyTorch训练性能数据结果文件和性能数据分析。

   性能数据结果文件详细介绍请参见Ascend PyTorch Profiler接口采集数据，性能数据分析请参见《MindStudio Insight 用户指南》将解析后的性能数据文件进行可视化展示和分析。

采集并解析性能数据（dynamic_profile）

dynamic_profile主要功能是在执行模型训练过程中可以随时开启采集进程。

dynamic_profile支持多种开启方式，以下方式只选择一种使用，不可同时使用两种及以上方式开启dynamic_profile。

方式一：环境变量方式

1. 配置如下环境变量：

   export PROF_CONFIG_PATH="profiler_config_path"

   配置该环境变量后启动训练，dynamic_profile会在profiler_config_path下自动创建模板文件profiler_config.json，用户可基于模板文件自定义修改配置项。

   

   • 该方式仅支持训练场景。
   • 该方式下dynamic_profile不支持采集第一个迭代（step0）的数据。
   • 该方式依赖torch原生Optimizer.step()划分训练过程中Profiling的step，不支持自定义Optimizer场景。
   • profiler_config_path路径格式仅支持由字母、数字和下划线组成的字符串，不支持软链接。
2. 启动训练任务。
3. 重新开启一个命令行窗口，修改profiler_config.json配置文件用以使能Profiling任务。
   配置文件中包含Profiler的性能数据采集参数，用户可以参考profiler_config.json文件说明修改配置文件参数来执行不同的Profiling任务。

   

   • dynamic_profile通过识别profiler_config.json文件的状态判断文件是否被修改：
     • dynamic_profile每2s轮询一次，若发现profiler_config.json文件改动，则启动采集进程，之后记录step10到step11之间的运行间隔，将此时间作为新的轮询时间，最小值为1s。
     • 若在dynamic_profile采集执行期间，profiler_config.json文件被修改，则在采集进程结束之后，再次启动最后一次文件修改的dynamic_profile采集。
   • 建议用户使用共享存储设置dynamic_profile的profiler_config_path。
   • profiler_config_path目录下会自动记录dynamic_profile的维测日志，详细介绍请参见dynamic_profile动态采集维测日志介绍。
4. 性能数据解析。

   支持自动解析和手动解析，请参见表5中的analyse参数。

5. 查看采集到的PyTorch训练性能数据结果文件和性能数据分析。

   性能数据结果文件详细介绍请参见Ascend PyTorch Profiler接口采集数据，性能数据分析请参见《MindStudio Insight 用户指南》将解析后的性能数据文件进行可视化展示和分析。

方式二：修改用户训练脚本（如train_*.py文件），添加dynamic_profile接口方式启动采集

1. 在训练脚本中添加如下示例代码加粗部分：

   # 加载dynamic_profile模块
   from torch_npu.profiler import dynamic_profile as dp
   # 设置模型训练时Profiling配置文件的路径
   dp.init("profiler_config_path")
   …
   for step in steps:
          train_one_step()
           # 划分训练step
          dp.step()

   init时，dynamic_profile会在profiler_config_path下自动创建模板文件profiler_config.json，用户可基于模板文件自定义修改配置项。

   profiler_config_path路径格式仅支持由字母、数字和下划线组成的字符串，不支持软链接。

2. 启动训练任务。
3. 重新开启一个命令行窗口，修改profiler_config.json配置文件用以使能Profiling任务。
   配置文件中包含Profiler的性能数据采集参数，用户可以参考profiler_config.json文件说明修改配置文件参数来执行不同的Profiling任务。

   

   • dynamic_profile通过识别profiler_config.json文件的状态判断文件是否被修改：
     • dynamic_profile每2s轮询一次，若发现profiler_config.json文件改动，则启动采集进程，之后记录step10到step11之间的运行间隔，将此时间作为新的轮询时间，最小值为1s。
     • 若在dynamic_profile采集执行期间，profiler_config.json文件被修改，则在采集进程结束之后，再次启动最后一次文件修改的dynamic_profile采集。
   • 建议用户使用共享存储设置dynamic_profile的profiler_config_path。
   • profiler_config_path目录下会自动记录dynamic_profile的维测日志，详细介绍请参见dynamic_profile动态采集维测日志介绍。
4. 性能数据解析。

   支持自动解析和手动解析，请参见表5中的analyse参数。

5. 查看采集到的PyTorch训练性能数据结果文件和性能数据分析。

   性能数据结果文件详细介绍请参见Ascend PyTorch Profiler接口采集数据，性能数据分析请参见《MindStudio Insight 用户指南》将解析后的性能数据文件进行可视化展示和分析。

方式三：修改用户训练脚本（如train_*.py文件），添加dynamic_profile的dp.start()函数方式启动采集

1. 在训练脚本中添加如下示例代码加粗部分：

   # 加载dynamic_profile模块
   from torch_npu.profiler import dynamic_profile as dp
   # 设置init接口Profiling配置文件路径
   dp.init("profiler_config_path")
   …
   for step in steps:
           if step==5:
                   # 设置start接口Profiling配置文件路径
                   dp.start("start_config_path")
           train_one_step()
           # 划分训练step，需要进行profile的训练步骤代码需在dp.start()接口和dp.step()接口之间
           dp.step()

   start_config_path同样指定为profiler_config.json，但需要用户根据profiler_config.json文件说明手动创建配置文件并根据场景需要配置参数。此处须指定具体文件名，例如dp.start("./home/xx/start_config_path/profiler_config.json")。

   profiler_config_path和start_config_path路径格式仅支持由字母、数字和下划线组成的字符串，不支持软链接。

   

   • 添加dp.start()后，当训练任务进行到dp.start()时，会自动按照start_config_path指定的profiler_config.json文件进行采集。dp.start()函数不感知profiler_config.json文件的修改，只会在训练过程中触发一次采集任务。
   • 添加dp.start()并启动训练后：
     • 若dp.start()未指定profiler_config.json配置文件或配置文件因错误未生效，则执行到dp.start()后按照profiler_config_path目录下的profiler_config.json文件配置进行采集。
     • 若在dp.init()配置的dynamic_profile生效期间，脚本运行至dp.start()，则dp.start()不生效。
     • 若在dp.init()配置的dynamic_profile采集结束后，脚本运行至dp.start()，则继续执行dp.start()采集，并在prof_dir目录下生成新的性能数据文件目录。
     • 若在dp.start()配置的dynamic_profile生效期间，改动profiler_config_path目录下的profiler_config.json文件，dp.init()会等待dp.start()采集完成后启动，并在prof_dir目录下生成新的性能数据文件目录。
   • 建议用户使用共享存储设置dynamic_profile的profiler_config_path。
2. 启动训练任务。
3. 性能数据解析。

   支持自动解析和手动解析，请参见表5中的analyse参数。

4. 查看采集到的PyTorch训练性能数据结果文件和性能数据分析。

   性能数据结果文件详细介绍请参见Ascend PyTorch Profiler接口采集数据，性能数据分析请参见《MindStudio Insight 用户指南》将解析后的性能数据文件进行可视化展示和分析。

采集并解析性能数据（torch_npu.profiler._KinetoProfile）

1. 在训练脚本（如train_*.py文件）内添加如下示例代码进行性能数据采集参数配置，之后启动训练。下列示例代码中，加粗字段为需要配置的参数、方法、类和函数。
   

   以下示例代码中的torch_npu.profiler._KinetoProfile接口详细介绍请参见Ascend PyTorch Profiler接口说明。

   import torch
   import torch_npu
   
   ...
   
   prof = torch_npu.profiler._KinetoProfile(activities=None, record_shapes=False, profile_memory=False, with_stack=False, with_flops=False, with_modules=False, experimental_config=None)
   for epoch in range(epochs):
       trian_model_step()
       if epoch == 0:
           prof.start()
       if epoch == 1:
           prof.stop()
   prof.export_chrome_trace("result_dir/trace.json")

   该方式不支持使用schedule和tensorboard_trace_handler导出性能数据。

2. 性能数据解析。

   支持自动解析（参照以上示例代码中prof.export_chrome_trace）。

3. 查看采集到的PyTorch训练性能数据结果文件和性能数据分析。

   性能数据结果文件详细介绍请参见Ascend PyTorch Profiler接口采集数据，性能数据分析请参见《MindStudio Insight 用户指南》将解析后的性能数据文件进行可视化展示和分析。

采集并解析msprof_tx数据（可选）

针对大集群场景传统Profiling数据量大、分析流程复杂的现象，通过experimental_config的msprof_tx参数开启自定义打点功能，自定义采集时间段或者关键函数的开始和结束时间点，识别关键函数或训练迭代等信息，对性能问题快速定界。

使用方式及示例代码如下：

1. 使能torch_npu.profiler，打开msprof_tx开关，搭配profiler_level开关设置为Level_none（可根据实际采集需要，配置对应的level），采集打点数据。
2. 在PyTorch脚本中对于想采集的事件调用torch_npu.npu.mstx、torch_npu.npu.mstx.mark、torch_npu.npu.mstx.range_start、torch_npu.npu.mstx.range_end、torch_npu.npu.mstx.mstx_range的打点mark接口实现打点，采集对应事件的耗时。接口详细介绍请参见《Ascend Extension for PyTorch API 参考》中的“Ascend Extension for PyTorch自定义API > torch_npu.npu > profiler”。

只记录host侧range耗时：

id = torch_npu.npu.mstx.range_start("dataloader", None)    # 第二个入参设置None或者不设置，只记录host侧range耗时
dataloader()
torch_npu.npu.mstx.range_end(id)

在计算流上打点，记录host侧range耗时和device侧对应的range耗时：

stream = torch_npu.npu.current_stream()
id = torch_npu.npu.mstx.range_start("matmul", stream)    # 第二个入参设置有效的stream，记录host侧range耗时和device侧对应的range耗时
torch.matmul()
torch_npu.npu.mstx.range_end(id)

在集合通信流上打点：

from torch.distributed.distributed_c10d import _world

if (torch.__version__ != '1.11.0') :
    stream_id = _world.default_pg._get_backend(torch.device('npu'))._get_stream_id(False)
    collective_stream = torch.npu.Stream(stream_id=collective_stream_id, device_type=20)
else:
    stream_id = _world.default_pg._get_stream_id(False)
    current_stream = torch.npu.current_stream()
    cdata = current_stream._cdata & 0xffff000000000000
    collective_stream = torch.npu.Stream(_cdata=( stream_id + cdata))
id = torch_npu.npu.mstx.range_start("allreduce", collective_stream)    # 第二个入参设置有效的stream，记录host侧range耗时和device侧对应的range耗时
torch.allreduce()
torch_npu.npu.mstx.range_end(id)

在P2P通信流上打点：

from torch.distributed.distributed_c10d import _world
 
if (torch.__version__ != '1.11.0') :
    stream_id = _world.default_pg._get_backend(torch.device('npu'))._get_stream_id(True)
    p2p_stream = torch.npu.Stream(stream_id=collective_stream_id, device_type=20)
else:
    stream_id = _world.default_pg._get_stream_id(True)
    current_stream = torch.npu.current_stream()
    cdata = current_stream._cdata & 0xffff000000000000
    p2p_stream = torch.npu.Stream(_cdata=( stream_id + cdata))
id = torch_npu.npu.mstx.range_start("send", p2p_stream)    # 第二个入参设置有效的stream，记录host侧range耗时和device侧对应的range耗时
torch.send()
torch_npu.npu.mstx.range_end(id)

想要采集如上场景数据，需要配置torch_npu.profiler.profile接口，使能msprof_tx开关，参考样例如下：

import torch_npu

stream = torch_npu.npu.current_stream()
id = torch_npu.npu.mstx.range_start("Func", stream)    # 标识func函数在host侧以及在device侧的range开始
func()            # 业务代码
torch_npu.npu.mstx.range_end(id)            # 标识func函数在host侧以及在device侧的range结束     
    
experimental_config = torch_npu.profiler._ExperimentalConfig(
       profiler_level=torch_npu.profiler.ProfilerLevel.Level_none,
       msprof_tx=True,
       export_type=torch_npu.profiler.ExportType.Db
       )
with torch_npu.profiler.profile(
       schedule=torch_npu.profiler.schedule(wait=1, warmup=1, active=2, repeat=2, skip_first=1),
       on_trace_ready=torch_npu.profiler.tensorboard_trace_handler("./result"),
       experimental_config=experimental_config) as prof:
       
      for epoch in range(epochs):
          torch_npu.npu.mstx().mark("train epoch start")    # 标识在host侧以及在device侧的瞬时时刻
          for step in range(steps):
                   train_one_step(step, steps, train_loader, model, optimizer, criterion)
                   prof.step()

打点数据使用MindStudio Insight工具打开，可视化效果如下：

图1 打点结果示例

msprof_tx功能默认采集通信算子性能数据。

可以通过该功能查看用户自定义打点从框架侧到CANN层再到NPU侧的执行调度情况，进而帮助识别用户想观察的关键函数或者事件，定界性能问题。

msprof_tx采集结果数据详细介绍请参见msproftx数据说明。

采集环境变量信息（可选）

通过Ascend PyTorch Profiler接口采集性能数据时，默认采集环境变量信息，当前支持采集的环境变量如下：

• "ASCEND_GLOBAL_LOG_LEVEL"
• "HCCL_RDMA_TC"
• "HCCL_RDMA_SL"
• "ACLNN_CACHE_LIMIT"

操作步骤：

1. 在环境下配置环境变量，示例如下：

   export ASCEND_GLOBAL_LOG_LEVEL=1
   export HCCL_RDMA_TC=0
   export HCCL_RDMA_SL=0
   export ACLNN_CACHE_LIMIT=4096

   环境变量根据用户实际需要配置。

2. 执行Ascend PyTorch Profiler接口采集。
3. 查看结果数据。
   • 当experimental_config参数的export_type配置为torch_npu.profiler.ExportType.Text时，以上步骤配置的环境变量信息将保存在{worker_name}_{时间戳}_ascend_pt目录下的profiler_metadata.json文件中。
   • 当experimental_config参数的export_type配置为torch_npu.profiler.ExportType.Db时，在ascend_pytorch_profiler_{rank_id}.db文件下的META_DATA表写入环境变量信息。

以自定义字符串键和字符串值的形式标记性能数据采集过程（可选）

• 示例一

  with torch_npu.profiler.profile(…)  as prof:
      prof.add_metadata(key, value)

• 示例二

  with torch_npu.profiler._KinetoProfile(…)  as prof:
      prof.add_metadata_json(key, value)

add_metadata和add_metadata_json可以配置在torch_npu.profiler.profile和torch_npu.profiler._KinetoProfile下，须添加在profiler初始化后，finalize之前，即性能数据采集过程的代码中。

prof.add_metadata("test_key1", "test_value1")

prof.add_metadata_json("test_key2", [1, 2, 3])

调用此接口传入的metadata数据写入到Ascend PyTorch Profiler接口的采集结果根目录下的profiler_metadata.json文件中。

Ascend PyTorch Profiler接口说明

pid = os.getpid()
prof.export_chrome_trace(f'./chrome_trace_{pid}.json')

export_stacks('resule_dir/stack.log', metric='self_npu_time_total')

git clone https://github.com/brendangregg/FlameGraph
cd FlameGraph
./flamegraph.pl –title "NPU time" –countname "us." profiler.stacks > perf_viz.svg

prof = torch_npu.profiler.profile(
on_trace_ready=torch_npu.profiler.tensorboard_trace_handler("./result"))
for step in range(steps):
    if step == 5:
        prof.start()
    train_one_step()
    if step == 5:
        prof.stop()

性能数据会占据一定的磁盘空间，可能存在磁盘写满导致服务器不可用的风险。性能数据所需空间跟模型的参数、采集开关配置、采集的迭代数量有较大关系，须用户自行保证落盘目录下的可用磁盘空间。

profiler_config.json文件说明

profiler_config.json文件内容如下，以默认配置为例：

{
    "activities": ["CPU", "NPU"],
    "prof_dir": "./",
    "analyse": false,
    "record_shapes": false,
    "profile_memory": false,
    "with_stack": false,
    "with_flops": false,
    "with_modules": false,
    "active": 1,
    "is_rank": false,
    "rank_list": [],
    "experimental_config": {
        "profiler_level": "Level0",
        "aic_metrics": "AiCoreNone",
        "l2_cache": false,
        "op_attr": false,
        "gc_detect_threshold": null,
        "data_simplification": true,
        "record_op_args": false,
        "export_type": "text",
        "msprof_tx": false
    }
}

    "metadata": {
        "distributed_args":{
            "tp":2,
            "pp":4,
            "dp":8
        }
    }

experimental_config参数说明（dynamic_profile动态采集场景）

experimental_config参数均为可选参数，支持扩展的采集项如下：

experimental_config参数说明

experimental_config参数均为可选参数，支持扩展的采集项如下：

dynamic_profile动态采集维测日志介绍

profiler_config_path/
├── log
│    ├── dp_ubuntu_xxxxxx.log
│    ├── dp_ubuntu_xxxxxx.log.1
│    ├── monitor_dp_ubuntu_xxxxxx.log
│    ├── monitor_dp_ubuntu_xxxxxx.log.1
├── profiler_config.json
└── shm

• dp_ubuntu_xxxxxx.log：dynamic_profile动态采集的执行日志，记录动态采集执行过程中的所有动作（INFO）、警告（WARNING）和错误（ERROR）。文件命名格式：dp_{操作系统}_{训练进程ID}.log。

  训练启动时每个Rank会开启一个训练进程，dynamic_profile根据每个训练进程ID生成各个训练进程下的日志文件。

• dp_ubuntu_xxxxxx.log.1：日志老化备份文件，dp_ubuntu_xxxxxx.log文件的存储上限为200K，达到上限后将时间最早的日志记录转移到dp_ubuntu_xxxxxx.log.1中，dp_ubuntu_xxxxxx.log.1文件存储上限同样为200K，达到上限后则将最早的日志记录老化删除。
• monitor_dp_ubuntu_xxxxxx.log：profiler_config.json文件修改日志，开启dynamic_profile动态采集后，实时记录profiler_config.json文件的每次修改时间、修改是否生效以及dynamic_profile进程的结束，示例如下：

  2024-08-21 15:51:46,392 [INFO] [2127856] _dynamic_profiler_monitor.py: Dynamic profiler process load json success
  2024-08-21 15:51:58,406 [INFO] [2127856] _dynamic_profiler_monitor.py: Dynamic profiler process load json success
  2024-08-21 15:58:16,795 [INFO] [2127856] _dynamic_profiler_monitor.py: Dynamic profiler process done

  文件命名格式：monitor_dp_{操作系统}_{monitor进程ID}.log。

• monitor_dp_ubuntu_xxxxxx.log.1：日志老化备份文件，monitor_dp_ubuntu_xxxxxx.log文件的存储上限为200K，达到上限后将时间最早的日志记录转移到monitor_dp_ubuntu_xxxxxx.log.1中，monitor_dp_ubuntu_xxxxxx.log.1文件存储上限同样为200K，达到上限后则将最早的日志记录老化删除。
• shm目录：为了适配Python3.7，dynamic_profile会在py37环境下会生成shm目录，目录下生成一个二进制文件（DynamicProfileNpuShm+时间）映射共享内存， 程序正常结束后会自动清理，当手动killed程序后，由于是异常终止，程序无法释放资源，需要用户手动清理此文件，否则短时间内（<1h)下次使用同一配置路径启动dynamic_profile，则会导致dynamic_profile异常