From 530ae0f77484ff9c0025eb798cf4d0557cc31c45 Mon Sep 17 00:00:00 2001 From: jijiarong Date: Mon, 26 Aug 2024 15:53:05 +0800 Subject: [PATCH] kernel compare document --- .../msprobe/mindspore/doc/kernel_compare.md | 55 +++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 debug/accuracy_tools/msprobe/mindspore/doc/kernel_compare.md diff --git a/debug/accuracy_tools/msprobe/mindspore/doc/kernel_compare.md b/debug/accuracy_tools/msprobe/mindspore/doc/kernel_compare.md new file mode 100644 index 0000000000..70a1146ef4 --- /dev/null +++ b/debug/accuracy_tools/msprobe/mindspore/doc/kernel_compare.md @@ -0,0 +1,55 @@ +# 精度比对工具 + +msprobe精度比对工具主要通过对同一个模型，在两个不同的MindSpore环境下，输入相同的训练数据，在分别得到dump数据后，对这两个dump数据进行全量自动对比，从而快速定位不同版本之间的精度问题。 + +执行精度比对操作需要安装msprobe工具。详见《[MindStudio精度调试工具](../../README.md)》的“工具安装”章节。 + +## 命令行方式比对 + +精度比对工具目前使用方式为命令行形式，对MindSpore的dump数据支持单卡和多卡。 + +### 操作步骤 + +1. 使用MindSpore进行dump，得到不同框架版本的dump数据。 + +2. 执行如下示例命令进行比对： + + ```shell + msprobe -f mindspore compare --input_path ./compare.json --output ./output + ``` + + **完整参数说明** + + | 参数名 | 说明 | 是否必选 | + |-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------- | + | -i或--input_path | 指定比对文件路径。比对文件内容及示例请参见“**比对文件**”。 | 是 | + | -o或--output_path | 配置比对结果文件存盘目录。文件名称基于时间戳自动生成，格式为：`./output/compare_result_{rank_id}_{step_id}_{timestamp}.xlsx`。 | 是 | + +4. 查看比对结果，请详见PyTorch目录下的《[精度比对工具](../../pytorch/doc/ptdbg_ascend_compare.md)》的“比对结果分析”章节。 + +### 比对文件 + +以在当前目录创建./compare.json为例，单卡场景示例如下： + + ```json + { + "npu_path": "./npu_dump/", + "bench_path": "./bench_dump/", + "rank_id": [ + 0, + 1, + 2, + 3 + ], + "step_id": [] +} + ``` + +**参数说明** + +| 参数名 | 说明 | 是否必选 | +|------------|--------------------------|------| +| npu_path | 配置待比较数据的地址。数据类型：str。 | 是 | +| bench_path | 配置标杆数据的地址。数据类型：str。 | 是 | +| rank_id | 配置待比较的rank id。数据类型：list。 | 是 | +| step_id | 配置待比较的step id。数据类型：list | 是 | -- Gitee