命令格式说明

Tensor比对命令行格式如下:

python3 msaccucmp.py compare -m my_dump_path -g golden_dump_path [-f fusion_rule_file] [-cf close_fusion_rule_file] [-q quant_fusion_rule_file] [-out output] [-map] [-c custom_script_path] [-alg algorithm] [-v version] [-r range] [-overflow_detection]

命令行参数说明如表1所示。

精度比对工具保存在Ascend-cann-toolkit安装目录/ascend-toolkit/latest/tools/operator_cmp/compare目录下。

表1 整网比对命令行参数说明

参数名

参数说明

是否必选

-m

--my_dump_path

基于昇腾AI处理器运行生成的数据文件所在目录,即为比对场景中My Output模型的比对数据文件目录。

由于dump数据文件是多个二进制文件,故须指定dump数据文件所在的父目录。如:/home/HwHiAiUser/MyApp_mind/resnet50,其中resnet50文件夹下直接保存dump数据文件。

训练场景下:

  • 支持TensorFlow和PyTorch为原始训练网络的比对。
  • 单个数据文件比对时,需指定数据文件所在的具体目录。
  • 支持多个dump数据文件的批量比对,可指定固定路径为dump_path/time/,仅支持TensorFlow为原始训练网络的比对。指定的路径下可以存放多个dump数据文件,但要求每个dump数据文件拥有唯一路径,且路径命名规则为dump_path/time/device_id/model_name/model_id/dump_step/dump文件

    其中:dump_path为Dump文件保存路径;time为时间戳;device_id为Device设备ID号;model_name子图名称;model_id子图ID号;dump_step为指定采集哪些迭代的Data Dump数据,存在多个step时,只选step最大的进行比对;dump文件为dump文件名。

-g

--golden_dump_path

基于GPU/CPU运行生成的原始网络数据文件所在目录,即为比对场景中Ground Truth模型的比对数据文件目录。

由于npy数据文件是多个npy文件,故须指定npy数据文件所在的父目录。如:/home/HwHiAiUser/Standard_caffe/resnet50 其中resnet50文件夹下直接保存npy数据文件。

推理场景缺省情况下,该参数指定的就是模型转换开启算子融合下dump数据文件的目录;当指定-cf参数时,该参数指定的就是模型转换关闭算子融合下dump数据文件的目录。

-f

--fusion_rule_file

全网层信息文件。

推理场景:

  • 通过使用ATC转换.om模型文件生成的json文件,文件包含整网算子的映射关系。
  • 该参数指定的是默认开启算子融合情况下进行模型转换时生成的json文件;指定关闭算子融合情况下进行模型转换时生成的json文件使用-cf参数。

训练场景:

  • 通过使用ATC转换.txt图文件生成的json文件(.txt图文件为2查找的计算图文件)。
  • 单个数据文件比对时,该参数需指定具体的json文件;批量比对时,该参数可指定为多个json文件所在的目录。

-cf

--close_fusion_rule_file

离线模型全网层信息文件(通过使用ATC转换.om模型文件生成的json文件,文件包含关闭算子融合功能情况下整网算子的映射关系)。

本参数详细使用指导请参见比对步骤(推理场景融合算子精度问题排查)

仅推理场景支持本参数。

-q

--quant_fusion_rule_file

量化算子映射关系文件(昇腾模型压缩输出的json文件)。

仅推理场景支持本参数。

-out

--output

比对数据结果存放路径,默认为当前路径。

训练场景下:

  • 单个数据文件比对时,结果文件名格式为result_{timestamp}.csv。
  • 多个数据文件比对时,结果文件名格式为{device_id}_{model_name}_{dump_step}_result_{timestamp}.csv,批量比对将生成多个csv结果文件。

-map

--mapping

输出GPU/NPU的映射表。

一般情况下GPU/NPU的映射表需要在完成精度比对之后,才能从csv中获取。本参数实现在精度比对前,直接提取GPU/NPU的映射表。建议在比对数据量太大,需要提前获取GPU/NPU的映射表的场景下使用。详细操作请参见获取GPU/NPU的映射表

-c

--custom_script_path

用户自定义脚本文件存放路径,包括自定义算法.py文件和自定义Format转换.py文件,需指定到脚本目录的上一层目录。指定本参数时判断是否存在以下文件目录:

  • 存在自定义算法.py文件目录,目录格式为“algorithm”,则读取“algorithm”目录下的自定义算法.py文件,生成自定义算法,可通过-alg参数指定为比对算法。自定义算法.py文件相关要求参见准备自定义算法.py文件
  • 存在自定义Format转换.py文件目录,目录格式为“format_convert”,则读取“format_convert”目录下的自定义Format转换.py文件。自定义Format转换.py文件相关要求参见准备自定义Format转换.py文件

不建议调用与当前用户不一致的其它用户目录下的自定义脚本文件,避免提权风险。

-alg

--algorithm

比对维度,取值为:

  • 0:CosineSimilarity,表示余弦相似度算法。
  • 1:MaxAbsoluteError,表示最大绝对误差算法。
  • 2:AccumulatedRelativeError,表示累积相对误差算法。
  • 3:RelativeEuclideanDistance,表示欧氏相对距离算法。
  • 4:KullbackLeiblerDivergence,表示KL散度算法。
  • 5:StandardDeviation,表示标准差算法。
  • 6:MeanAbsoluteError,表示平均绝对误差。
  • 7:RootMeanSquareError,表示均方根误差。
  • 8:MaxRelativeError,表示最大相对误差。
  • 9:MeanRelativeError,表示平均相对误差。
  • all:比对全部算法(包含自定义和内置算法)。默认取值,
  • 自定义算法名(algorithm_name)。具体算法名由自定义算法文件确定,例如自定义算法文件名为alg_RelativeError.py,则自定义算法名为RelativeError。须同时配置-c参数。

可多选,配置格式为各取值间用逗号分隔,可配置为数字或算法名,例如0,1,2,RelativeError。

若只选择比对部分维度,则比对结果同样只展示对应维度。

-a

--algorithm_options

比对算法的高级选项,可为指定的算法设置参数,指定的算法必须是-alg参数的内置算法或者-c参数的自定义算法,被本参数设置后的算法以本参数设置的值执行运算。

输入格式为:算法名:参数名=值,参数名=值;算法名:参数名=值,参数名=值。参数之间是逗号分隔,不同算法是分号分隔,例如:"CosineSimilarity:max=1,min=0;aa:max=1,min=0"。其中算法名与-c参数自定义算法.py文件的algorithm_name(参见准备自定义算法.py文件)一致。

-v

--version

dump文件类型,1代表protobuf序列化后的数据文件,2代表自定义格式的数据文件。默认取2。

-r

--range

设定算子比对范围。配置方式如下:

  • start:第一个比对的算子,取值范围为[1, 参与计算的算子个数],默认值为1。
  • end:最后一个比对的算子,取值范围为-1或[start, 参与计算的算子个数],默认值为-1(动态获取网络模型中最后一个参与计算的算子)。
  • step:第start+step*n个比对的算子,step取值范围为[1, 参与计算的算子个数),默认值为1,n为从1开始的正整数。

配置格式为:“start,end,step”。比如:-r 1,101,20,表示算子1,21,41,61,81,101的Tensor参与比对。

不配置本参数时,比对网络模型中的所有参与计算的算子。

比对场景中的5、7场景不支持配置本参数。

须先配置-f或-cf参数指定离线模型全网层信息文件。

-s参数与-r参数二者只能选择一个配置。

-s

--select

设定算子比对范围。通过指定算子的索引(网络模型中算子的ID)来选择需要比对的算子,格式为:-s 1,2,3(数值之间以逗号隔开,取值与网络模型中算子的ID有关)。

须先配置-f或-cf参数指定离线模型全网层信息文件。

-s参数与-r参数二者只能选择一个配置。

-p

--post_process

精度比对时,提取dump数据文件以及比对结果文件中存在精度问题的数据,保存在结果文件同级目录的result_{timestamp}_filtered文件夹下。

取值为:

  • 0:表示不提取,默认不提取。
  • 1:提取存在精度问题的数据,若需提取则配置为1。

result_{timestamp}_filtered文件夹保存内容包括:

  • 提取后的比对结果:filtered_result.csv。
  • 提取的GPU和NPU数据(两个文件夹):gold_dump,my_dump。

不配置本参数时,比对并输出整网算子数据。

仅PyTorch比对支持本参数。

-overflow_detection

整网算子溢出检测。进行整网比对时可检测溢出算子。

默认未配置本参数。

当算子的Tensor数据类型是fp16时,tensor中的任意一个数值的绝对值 >= 65504,认为算子溢出。

比对场景中的5场景配置本参数不生效。

注1:请根据比对场景中准备的数据类型,正确选择-f或-q参数项。

注2:比对PyTorch算子的训练结果时,仅支持-m、-g、-out、-alg和-p五个参数。