--- title: aclmdlSetDump description: "| 产品 | 是否支持 |" url: https://www.hiascend.com/document/detail/zh/canncommercial/latest/API/runtimeapi/aclcppdevg_03_0315.html sourcePath: /source/zh/canncommercial/900/API/runtimeapi/aclcppdevg_03_0315.html indexId: c4ee666e4d7e65e7f8c1813efcfca987fd42a2c27b78d2e76c615cc24225ed6268 --- # aclmdlSetDump #### 产品支持情况 | 产品 | 是否支持 | | --- | --- | | Atlas 350 加速卡 | √ | | Atlas A3 训练系列产品 / Atlas A3 推理系列产品 | √ | | Atlas A2 训练系列产品 / Atlas A2 推理系列产品 | √ | | Atlas 200I/500 A2 推理产品 | √ | | Atlas 推理系列产品 | √ | | Atlas 训练系列产品 | √ | #### 功能说明 设置Dump参数。 aclmdlInitDump接口、aclmdlSetDump接口、aclmdlFinalizeDump接口配合使用，用于将Dump数据记录到文件中。一个进程内，可以根据需求多次调用这些接口，基于不同的Dump配置信息，获取Dump数据。场景举例如下：- 执行两个不同的模型，需要设置不同的Dump配置信息，接口调用顺序： aclInit 接口--> aclmdlInitDump 接口--> aclmdlSetDump 接口-->模型1加载-->模型1执行--> aclmdlFinalizeDump 接口-->模型1卸载--> aclmdlInitDump 接口--> aclmdlSetDump 接口-->模型2加载-->模型2执行--> aclmdlFinalizeDump 接口-->模型2卸载-->执行其它任务--> aclFinalize 接口 - 同一个模型执行两次，第一次需要Dump，第二次无需Dump，接口调用顺序： aclInit 接口--> aclmdlInitDump 接口--> aclmdlSetDump 接口-->模型加载-->模型执行--> aclmdlFinalizeDump 接口-->模型卸载-->模型加载-->模型执行-->执行其它任务--> aclFinalize 接口 #### 函数原型 ``` aclError aclmdlSetDump(const char *dumpCfgPath) ``` #### 参数说明 | 参数名 | 输入/输出 | 说明 | | --- | --- | --- | | dumpCfgPath | 输入 | 配置文件路径的指针，包含文件名。配置文件格式为json格式。 可通过该配置文件配置开启或配置各类Dump信息，详细描述请参见下文各功能配置示例中的描述。如果算子输入或输出中包含用户的敏感信息，则存在信息泄露风险。 | #### 返回值说明 返回0表示成功，返回其他值表示失败，请参见aclError。 #### 约束说明 - 只有在调用本接口开启Dump之后加载模型，配置的Dump信息有效。在调用本接口之前已经加载的模型不受影响，除非用户在调用本接口后重新加载该模型。 例如以下接口调用顺序中，加载的模型1不受影响，配置的Dump信息仅对加载的模型2有效： aclmdlInitDump接口-->模型1加载-->aclmdlSetDump接口-->模型2加载-->aclmdlFinalizeDump接口 - 多次调用本接口对同一个模型配置了Dump信息，系统内处理时会采用覆盖策略。 例如以下接口调用顺序中，第二次调用本接口配置的Dump信息会覆盖第一次配置的Dump信息： aclmdlInitDump接口-->aclmdlSetDump接口-->aclmdlSetDump接口-->模型1加载-->aclmdlFinalizeDump接口 #### 模型Dump配置、单算子Dump配置 模型Dump配置（用于导出模型中每一层算子输入和输出数据）、单算子Dump配置（用于导出单个算子的输入和输出数据），导出的数据用于与指定模型或算子进行比对，定位精度问题，具体比对方法请参见《精度调试工具(https://www.hiascend.com/document/detail/zh/canncommercial/900/devaids/ModelAccuracyAnalyzer/atlasaccuracy_16_1000.html)》。默认不启用该Dump配置。 通过本接口启用Dump配置，需通过dump_path参数配置保存Dump数据的路径。 模型Dump配置示例如下： ``` { "dump":{ "dump_list":[ { "model_name":"ResNet-101" }, { "model_name":"ResNet-50", "layer":[ "conv1conv1_relu", "res2a_branch2ares2a_branch2a_relu", "res2a_branch1", "pool1" ] } ], "dump_path":"/home/output", "dump_mode":"output", "dump_op_switch":"off", "dump_data":"tensor" } } ``` 单算子调用场景下，Dump配置示例如下： ``` { "dump":{ "dump_path":"/home/output", "dump_list":[{}], "dump_op_switch":"on", "dump_data":"tensor" } } ``` **表1 acl.json文件格式说明** | 配置项 | 参数说明 | | | | --- | --- | --- | --- | | dump\_list | （必选）待dump数据的整网模型列表。 模型推理场景下，当需要Dump全部算子时，配置为： "dump\_list":[{}] 当需要Dump多个模型或特定算子时，需要结合model\_name和layer使用。 在单算子调用场景（包括单算子模型执行和单算子API执行）下，dump\_list建议配置为： "dump\_list":[{}] | | | | model\_name | 模型名称，各个模型的model\_name值须唯一。 模型加载方式为文件加载时，填入模型文件的名称，不需要带后缀名；也可以配置为ATC模型文件转换后的json文件里的最外层"name"字段对应值。 模型加载方式为内存加载时，配置为ATC模型文件转换后的json文件里的最外层"name"字段对应值。 | | | | layer | IO性能较差时，可能会因为数据量过大而导致执行超时，因此不建议进行全量dump，请指定算子进行dump。通过该字段可以指定需要dump的算子名，支持指定为ATC模型转换后的算子名，也支持指定为转换前的原始算子名，配置时需注意： 需按格式配置，每行配置模型中的一个算子名，且每个算子之间用英文逗号隔开。 用户可以无需设置model\_name，此时会默认dump所有model下的相应算子。如果配置了model\_name，则dump对应model下的相应算子。 若指定的算子其输入涉及data算子，会同时将data算子信息dump出来；若需dump data算子，需要一并填写data节点算子的后继节点，才能dump出data节点算子数据。 当需要dump模型中所有算子时，不需要包含layer字段。 | | | | optype\_blacklist | 配置dump数据黑名单，黑名单中的指定类型的算子的输入或输出数据不会进行数据dump，用户可通过该配置控制dump的数据量。 该功能仅在执行模型数据dump操作，且dump\_level为op时生效，同时支持和opname\_blacklist配合使用。 配置示例： { "dump":{ "dump\_list":[ { "model\_name":"ResNet\-50", "optype\_blacklist":[ { "name":"conv" "pos":["input0", "input1"] } ] } ], "dump\_path":"/home/output", "dump\_mode":"input", } } 以上示例表示：不对conv算子的input0数据和input1数据执行dump操作，conv为算子类型。 optype\_blacklist中包括name和pos字段，配置时需注意： name表示算子类型，支持指定为ATC模型转换后的算子类型，配置为空时该过滤项不生效。 pos表示算子的输入或输出，仅支持配置为inputn或outputn格式，其中n表示输入输出索引号。配置为空时该过滤项不生效。 optype\_blacklist内最多支持配置100个过滤项。 如果配置了model\_name，则仅对该model下的算子生效。如果不配置model\_name，则对所有model下的算子生效。 | | | | opname\_blacklist | 配置dump数据黑名单，黑名单中的指定名称的算子的输入或输出数据不会进行数据dump，用户可通过该配置控制dump的数据量。 该功能仅在执行模型数据dump操作，且dump\_level为op时生效，同时支持和optype\_blacklist配合使用。 配置示例： { "dump":{ "dump\_list":[ { "model\_name":"ResNet\-50", "opname\_blacklist":[ { "name":"conv" "pos":["input0", "input1"] } ] } ], "dump\_path":"/home/output", "dump\_mode":"input", } } 以上示例表示：不对conv算子的input0数据和input1数据执行dump操作，conv为算子名称。 opname\_blacklist中包括name和pos字段，配置时需注意： name表示算子名称，支持指定为ATC模型转换后的算子名称，配置为空时该过滤项不生效。 pos表示算子的输入或输出，仅支持配置为inputn或outputn格式，其中n表示输入输出索引号。配置为空时该过滤项不生效。 opname\_blacklist内最多支持配置100个过滤项。 如果配置了model\_name，则仅对该model下的算子生效。如果不配置model\_name，则对所有model下的算子生效。 | | | | opname\_range | 配置dump数据范围，对begin到end闭区间内的数据执行dump操作。 该功能仅在执行模型数据dump操作，且dump\_level为op时生效。 配置示例： { "dump":{ "dump\_list":[ { "model\_name":"ResNet\-50", "opname\_range":[{"begin":"conv1", "end":"relu1" }, {"begin":"conv2", "end":"pool1"}] } ], "dump\_mode":"output", "dump\_level": "op", "dump\_path":"/home/output" } } 以上示例表示对conv1到relu1、conv2到pool1闭区间内的数据执行dump操作，conv1、relu1、conv2、pool1表示算子名称。 配置时需注意： model\_name不允许为空。 begin和end中的参数表示算子名称，支持指定为ATC模型转换后的算子名称。 begin和end不允许为空，且只能配置为非data算子；若begin和end范围内算子的输入涉及data算子，会同时对data算子信息执行dump操作。 | | | | dump\_path | （必选）dump数据文件存储到运行环境的目录，该目录需要提前创建且确保安装时配置的运行用户具有读写权限。 支持配置绝对路径或相对路径： 绝对路径配置以“/”开头，例如：/home/output。 相对路径配置直接以目录名开始，例如：output。 | | | | dump\_mode | dump数据模式。 input：dump算子的输入数据。 output：dump算子的输出数据，默认取值output。 all：dump算子的输入、输出数据。 注意，配置为all时，由于部分算子在执行过程中会修改输入数据，例如集合通信类算子HcomAllGather、HcomAllReduce等，因此系统在进行dump时，会在算子执行前dump算子输入，在算子执行后dump算子输出，这样，针对同一个算子，算子输入、输出的dump数据是分开落盘，会出现多个dump文件，在解析dump文件后，用户可通过文件内容判断是输入还是输出。 | | | | dump\_level | dump数据级别，取值： op：按算子级别dump数据。 kernel：按kernel级别dump数据。 all：默认值，op和kernel级别的数据都dump。 默认配置下，dump数据文件会比较多，例如有一些aclnn开头的dump文件，若用户对dump性能有要求或内存资源有限时，则可以将该参数设置为op级别，以便提升dump性能、精简dump数据文件数量。 说明：算子是一个运算逻辑的表示（如加减乘除运算），kernel是运算逻辑真正进行计算处理的实现，需要分配具体的计算设备完成计算。 | | | | dump\_op\_switch | 单算子调用场景（包括单算子模型执行和单算子API执行）下，是否开启dump数据采集。 on：开启。 off：关闭，默认取值off。 | | | | dump\_step | 指定采集哪些迭代的dump数据。推理场景无需配置。 不配置该参数，默认所有迭代都会产生dump数据，数据量比较大，建议按需指定迭代。 多个迭代用“\|”分割，例如：0\|5\|10；也可以用“\-”指定迭代范围，例如：0\|3\-5\|10。 配置示例： 1 2 3 4 5 6 7 8 9 10 11 { "dump":{ "dump\_list":[ ...... ], "dump\_path":"/home/output", "dump\_mode":"output", "dump\_op\_switch":"off", "dump\_step": "0\|3\-5\|10" } } 训练场景下，若通过acl.json中的dump\_step参数指定采集哪些迭代的dump数据，又同时在GEInitialize接口中配置了ge.exec.dumpStep参数（该参数也用于指定采集哪些迭代的dump数据），则以最后配置的参数为准。GEInitialize接口的详细介绍请参见《图开发(https://www.hiascend.com/document/detail/zh/canncommercial/900/programug/graphdevg/atlasag\_25\_0081.html)》。 | 1 2 3 4 5 6 7 8 9 10 11 | { "dump":{ "dump\_list":[ ...... ], "dump\_path":"/home/output", "dump\_mode":"output", "dump\_op\_switch":"off", "dump\_step": "0\|3\-5\|10" } } | | 1 2 3 4 5 6 7 8 9 10 11 | { "dump":{ "dump\_list":[ ...... ], "dump\_path":"/home/output", "dump\_mode":"output", "dump\_op\_switch":"off", "dump\_step": "0\|3\-5\|10" } } | | | | dump\_data | 算子dump内容类型，取值： tensor: dump算子数据，默认为tensor。 stats: dump算子统计数据，结果文件为csv格式，文件中包含算子名称、输入/输出的数据类型、最大值、最小值等。 通常dump数据量太大并且耗时长，可以先对算子统计数据进行dump，根据统计数据识别可能异常的算子，然后再dump算子数据。 | | | | dump\_stats | 当dump\_data=stats时，可通过本参数设置收集统计数据中的哪一类数据。 仅 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 支持该参数。 本参数取值如下（若不指定取值，默认采集Max、Min、Avg、Nan、Negative Inf、Positive Inf数据）： Max：dump算子统计数据中的最大值。 Min：dump算子统计数据中的最小值。 Avg：dump算子统计数据中的平均值。 Nan：dump算子统计数据中未定义或不可表示的数值，仅针对浮点类型half、bfloat、float。 Negative Inf：dump算子统计数据中的负无穷值，仅针对浮点类型half、bfloat、float。 Positive Inf：dump算子统计数据中的正无穷值，仅针对浮点类型half、bfloat、float。 L2norm：dump算子统计数据的L2Norm值。 配置示例： 1 2 3 4 5 6 7 8 9 10 11 { "dump":{ "dump\_list":[ ...... ], "dump\_path":"/home/output", "dump\_mode":"output", "dump\_data":"stats", "dump\_stats":["Max", "Min"] } } | 1 2 3 4 5 6 7 8 9 10 11 | { "dump":{ "dump\_list":[ ...... ], "dump\_path":"/home/output", "dump\_mode":"output", "dump\_data":"stats", "dump\_stats":["Max", "Min"] } } | | 1 2 3 4 5 6 7 8 9 10 11 | { "dump":{ "dump\_list":[ ...... ], "dump\_path":"/home/output", "dump\_mode":"output", "dump\_data":"stats", "dump\_stats":["Max", "Min"] } } | | | #### 配置文件示例（异常算子Dump配置） 异常算子Dump配置（用于导出异常算子的输入输出数据、workspace信息、Tiling信息），导出的数据用于分析AI Core Error问题。默认不启用该Dump配置 通过配置dump_scene参数值开启异常算子Dump功能，配置文件中的示例内容如下，表示开启轻量化的exception dump： ``` { "dump":{ "dump_path":"output", "dump_scene":"aic_err_brief_dump" } } ``` 详细配置说明及约束如下： - dump_scene参数支持如下取值： - aic_err_brief_dump：表示轻量化exception dump，用于导出AI Core错误算子的输入&输出、workspace数据。 - aic_err_norm_dump：表示普通exception dump，在轻量化exception dump基础上，还会导出Shape、Data Type、Format以及属性信息。 - aic_err_detail_dump：在轻量化exception dump基础上，还会导出AI Core的内部存储、寄存器以及调用栈信息。 配置该选项时，有以下注意事项： - 该选项仅支持以下型号，且需配套25.0.RC1或更高版本的驱动才可以使用： Atlas A2 训练系列产品 / Atlas A2 推理系列产品 Atlas A3 训练系列产品 / Atlas A3 推理系列产品 您可以单击Link(https://www.hiascend.com/hardware/firmware-drivers/commercial)，在“固件与驱动”页面下载Ascend HDK 25.0.RC1或更高版本的驱动安装包，并参考相应版本的文档进行安装、升级。 - 若设置aic_err_detail_dump选项，则需在 aclrtSetDevice 接口之前调用本接口，且通过 aclmdlFinalizeDump 接口无法实现Dump去初始化。 - 导出dump文件过程中，会暂停问题算子所在的AI Core，因此可能会影响Device上其它业务进程的正常执行，导出dump文件后，会自行恢复AI Core。 - 导出dump文件后，会强制退出Host侧用户业务进程，强制退出过程中的报错可不作为AI Core问题分析的输入。 - 如果多个Host侧用户业务进程指定同一个Device、且都配置了aic_err_detail_dump选项，则先执行的进程按aic_err_detail_dump选项导出dump文件，后执行的进程按照aic_err_brief_dump选项导出dump文件。 - lite_exception：表示轻量化exception dump，为了兼容旧版本，效果等同于aic_err_brief_dump。 - dump_path是可选参数，表示导出dump文件的存储路径。 dump文件存储路径的优先级如下：NPU_COLLECT_PATH环境变量 > ASCEND_WORK_PATH环境变量 > 配置文件中的dump_path > 应用程序的当前执行目录 环境变量的详细描述请参见《环境变量参考(https://www.hiascend.com/document/detail/zh/canncommercial/900/maintenref/envvar/envref_07_0001.html)》。 - 若需查看导出的dump文件内容，先将dump文件转换为numpy格式文件后，再通过Python查看numpy格式文件，详细转换步骤请参见《精度调试工具(https://www.hiascend.com/document/detail/zh/canncommercial/900/devaids/ModelAccuracyAnalyzer/atlasaccuracy_16_1000.html)》中的“查看dump数据文件(https://www.hiascend.comdocument/detail/zh/canncommercial/900/devaids/ModelAccuracyAnalyzer/atlasaccuracy_16_0055.html)”章节。 若将dump_scene参数设置为aic_err_detail_dump时，需使用msDebug工具查看导出的dump文件内容，详细方法请参见《算子开发工具(https://www.hiascend.com/document/detail/zh/canncommercial/900/devaids/optool/docs/zh/quick_start/mskpp_quick_start.md)》。 - 异常算子Dump配置，不能与模型Dump配置或单算子Dump配置同时开启。 #### 溢出算子Dump配置 溢出算子Dump配置，用于导出模型中溢出算子的输入和输出数据。导出的数据用于分析溢出原因，定位模型精度的问题。默认不启用该Dump配置。 将dump_debug参数设置为on表示开启溢出算子配置，配置文件中的示例内容如下： ``` { "dump":{ "dump_path":"output", "dump_debug":"on" } } ``` 详细配置说明及约束如下：- 不配置dump_debug或将dump_debug配置为off表示不开启溢出算子配置。 - 若开启溢出算子配置，则dump_path必须配置，表示导出dump文件的存储路径。 获取导出的数据文件后，文件的解析请参见《精度调试工具(https://www.hiascend.com/document/detail/zh/canncommercial/900/devaids/ModelAccuracyAnalyzer/atlasaccuracy_16_1000.html)》中的“溢出算子数据采集与解析(https://www.hiascend.comdocument/detail/zh/canncommercial/900/devaids/ModelAccuracyAnalyzer/atlasaccuracy_16_0052.html)”章节。 dump_path支持配置绝对路径或相对路径： - 绝对路径配置以“/”开头，例如：/home。 - 相对路径配置直接以目录名开始，例如：output。 - 溢出算子Dump配置，不能与模型Dump配置或单算子Dump配置同时开启，否则会返回报错。 - 仅支持采集AI Core算子的溢出数据。 #### 算子Dump Watch模式配置 算子Dump Watch模式配置，用于开启指定算子输出数据的观察模式。在定位部分算子精度问题且已排除算子本身的计算问题后，若怀疑被其它算子踩踏内存导致精度问题，可开启Dump Watch模式。默认不开启Dump Watch模式。 将dump_scene参数设置为watcher，开启算子Dump Watch模式，配置文件中的示例内容如下，配置效果为：（1）当执行完A算子、B算子时，会把C算子和D算子的输出Dump出来；（2）当执行完C算子、D算子时，也会把C算子和D算子的输出Dump出来。将（1）、（2）中的C算子、D算子的Dump文件进行比较，用于排查A算子、B算子是否会踩踏C算子、D算子的输出内存。 ``` { "dump":{ "dump_list":[ { "layer":["A", "B"], "watcher_nodes":["C", "D"] } ], "dump_path":"/home/", "dump_mode":"output", "dump_scene":"watcher" } } ``` 详细配置说明及约束如下： - 若开启算子Dump Watch模式，则不支持同时开启溢出算子Dump（配置dump_debug参数）或开启单算子模型Dump（配置dump_op_switch参数），否则报错。该模式在单算子API Dump场景下不生效。 - 在dump_list中，通过layer参数配置可能踩踏其它算子内存的算子名称，通过watcher_nodes参数配置可能被其它算子踩踏输出内存导致精度有问题的算子名称。 - 若不指定layer，则模型内所有支持Dump的算子在执行后，都会将watcher_nodes中配置的算子的输出Dump出来。 - layer和watcher_nodes处配置的算子都必须是静态图、静态子图中的算子，否则不生效。 - 若layer和watcher_nodes处配置的算子名称相同，或者layer处配置的是集合通信类算子（算子类型以Hcom开头，例如HcomAllReduce），则只导出watcher_nodes中所配置算子的dump文件。 - 对于融合算子，watcher_nodes处配置的算子名称必须是融合后的算子名称，若配置融合前的算子名称，则不导出dump文件。 - dump_list内暂不支持配置model_name。 - 开启算子Dump Watch模式，则dump_path必须配置，表示导出dump文件的存储路径。 此处收集的dump文件无法通过文本工具直接查看其内容，若需查看dump文件内容，先将dump文件转换为numpy格式文件后，再通过Python查看numpy格式文件，详细转换步骤请参见《精度调试工具(https://www.hiascend.com/document/detail/zh/canncommercial/900/devaids/ModelAccuracyAnalyzer/atlasaccuracy_16_1000.html)》中的“查看dump数据文件(https://www.hiascend.comdocument/detail/zh/canncommercial/900/devaids/ModelAccuracyAnalyzer/atlasaccuracy_16_0055.html)”章节。 dump_path支持配置绝对路径或相对路径： - 绝对路径配置以“/”开头，例如：/home。 - 相对路径配置直接以目录名开始，例如：output。 - 通过dump_mode参数控制导出watcher_nodes中所配置算子的哪部分数据，当前仅支持配置为output。 #### 算子Kernel调测信息Dump配置 算子Kernel调测信息Dump配置，用于导出Ascend C算子Kernel的调测信息，便于定位算子问题。默认不启用该Dump配置。 仅如下型号支持该配置： Atlas 350 加速卡 Atlas A3 训练系列产品 / Atlas A3 推理系列产品 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 Atlas 200I/500 A2 推理产品 Atlas 推理系列产品 配置dump_kernel_data参数开启算子Kernel调测信息Dump功能，配置文件中的示例如下： ``` { "dump":{ "dump_kernel_data":"printf,assert", "dump_path":"/home/" } } ``` 详细配置说明及约束如下： - dump_kernel_data：指定导出数据的类型，支持配置多个类型，用英文逗号隔开。如果未配置该字段，但启用了模型Dump配置、单算子Dump配置，则默认按all导出调测信息。 当前支持如下类型： - all：导出以下所有类型调测的输出数据。 - printf：导出通过AscendC::printf调测的输出数据。 - tensor：导出通过AscendC::DumpTensor调测的输出数据。 - assert：导出通过assert/ascendc_assert调测的输出数据。 - timestamp：导出通过AscendC::PrintTimeStamp调测的输出数据。 - dump_path：启用算子Kernel调测信息Dump功能时，dump_path必须配置，表示导出Dump文件的存储路径，支持配置绝对路径或相对路径。 Dump文件存储路径的优先级如下：ASCEND_DUMP_PATH环境变量 > ASCEND_WORK_PATH环境变量 > 配置文件中的dump_path，环境变量的详细描述请参见《环境变量参考(https://www.hiascend.com/document/detail/zh/canncommercial/900/maintenref/envvar/envref_07_0001.html)》。 导出的Dump文件无法通过文本工具直接查看其内容，若需查看，需使用show_kernel_debug_data工具将调测信息解析为可读格式，工具使用指导请参见《Ascend C算子开发(https://www.hiascend.com/document/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas_ascendc_map_10_0002.html)》中的”“show_kernel_debug_data工具(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas_ascendc_10_0102.html)”。 #### 参考资源 当前还提供了aclInit接口，在初始化阶段，通过*.json文件传入Dump配置信息，运行应用后获取Dump数据的方式。该种方式，一个进程内，只能调用一次aclInit接口，如果要修改Dump配置信息，需修改*.json文件中的配置。