mindstudio-probe 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

msprobe/pytorch/doc/api_accuracy_checker_online.md

@@ -0,0 +1,187 @@
+# 在线精度预检
+
+为了应对大模型场景下，通过离线预检方式dump API输入输出数据导致的存储资源紧张问题，提供在线精度预检功能。本功能实现在执行NPU训练操作的过程中，通过TCP/IP协议在NPU
+Host与GPU Host设备间建立连接，将NPU上对应API的输入数据在GPU设备上运行，将两份输出数据进行比对，得到预检比对结果，从而减少数据dump的步骤，降低存储资源的占用。
+
+## 在线精度预检流程
+
+在线精度预检当前支持**局域网场景**和**共享存储场景**，请根据不同的场景选择对应的配置。
+
+在线精度预检操作流程如下：
+
+1. 准备GPU和NPU可正常运行的训练环境，PyTorch版本大于等于2.0，并保证两台Host在同一局域网内可正常通信或能通过共享存储进行通信。
+2. GPU和NPU Host设备上同时安装msprobe工具，详见《[MindStudio精度调试工具](./../../README.md)
+   》，其中在线预检要多安装twisted、pyOpenSSL依赖，该依赖为Python模块。
+3. 分别配置GPU侧、NPU侧的config.json文件。
+4. 在GPU侧运行msprobe -f pytorch run_ut -config ./config.json。
+5. 在NPU侧配置训练脚本。
+6. 在NPU侧执行训练。
+
+## 在线精度预检操作指导
+
+### 配置config.json文件
+
+安装完成预检工具后，需要分别在GPU和NPU环境下分别配置config.json。其中需要重点关注文件中的is_online、is_benchmark_device、host和port参数的配置，保障在线预检时GPU和NPU两台设备间的通信正常。
+
+#### GPU侧在线预检配置说明
+
+| 参数名称            | 说明                                                                                                                    | 是否必选 |
+|-----------------|-----------------------------------------------------------------------------------------------------------------------|------|
+| task            | 任务名称，str类型，配置为run_ut表示预检任务。通过其他字段is_online判断离线预检、在线预检任务。                                                              | 是    |
+| white_list      | 预检的API白名单，list[str]类型。参数示例：white_list=["conv1d", "conv2d"]。默认未配置白名单，即预检全量API数据。                                       | 否    |
+| black_list      | 预检的API黑名单，list[str]类型。参数示例：white_list=["conv1d", "conv2d"]。默认未配置黑名单，即预检全量API数据。                                       | 否    |
+| error_data_path | 配置保存精度未达标的API输入输出数据路径，str类型。在线预检模式下该参数不生效。                                                                            | 否    |
+| is_online       | 在线预检模式开关，bool类型，可取值True（开启）、False（关闭），默认关闭。                                                                           | 是    |
+| nfs_path        | 在线预检模式共享存储目录路径，str类型，用于GPU设备和NPU设备间进行通信。配置该参数后host和port不生效。                                                           | 否    |
+| host            | 在线预检模式局域网场景信息接收端IP，str类型，用于GPU设备和NPU设备间进行通信，GPU侧配置为本机地址127.0.0.1或本机局域网IP。局域网场景时，不能配置nfs_path参数，否则局域网场景不生效。            | 否    |
+| port            | 在线预检模式局域网场景信息接收端端口号，int类型，用于GPU设备和NPU设备间进行通信，GPU侧配置为本机可用端口。局域网场景时，不能配置nfs_path参数，否则局域网场景不生效。                          | 否    |
+| rank_list       | 指定在线预检的Rank ID，默认值为[0]，list[int]类型，应配置为大于等于0的整数，且须根据实际卡的Rank ID配置，若所配置的值大于实际训练所运行的卡的Rank ID，则在线预检输出数据为空。GPU和NPU须配置一致。 | 是    |
+
+#### NPU侧在线预检配置说明
+
+| 参数名称             | 说明                                                                                                     | 是否必选 |
+|------------------|--------------------------------------------------------------------------------------------------------|------|
+| task             | 任务名称，str类型，配置为tensor表示dump API统计信息和完全复刻整网的API运行情况的真实数据。通过字段onlin_run_ut判断是否使用在线预检功能。                   | 是    |
+| dump_path        | dump路径，str类型，配置为合法路径即可，兼容tensor任务静态检查                                                                  | 是    |
+| level            | dump级别，str类型，在线预检时配置为L1，表示dump API级精度数据。在线预检可不配置，默认取值L1。                                               | 是    |
+| rank             | 指定对某张卡上的数据进行dump，list[int]类型，默认未配置(表示dump所有卡的数据)，需要与GPU侧配置项rank_list保持一致。                              | 否    |
+| step             | 指定dump某个step的数据，list[int]类型，默认未配置，表示dump所有step的数据。dump特定step时，须指定为训练脚本中存在的step。                        | 否    |
+| seed             | 随机种子数，int类型，默认值为1234。通过固定随机数保证模型的输入或输出一致。                                                              | 否    |
+| is_deterministic | 确定性计算模式，bool类型，可取值true（开启）或false（关闭），默认关闭。                                                             | 否    |
+| scope            | dump范围，list[str]类型，默认未配置（list也未配置时师表dump所有api的额数据），配置方式参考[《config配置文件说明》](./../../config/README.md)    | 否    |
+| list             | 自定义dump范围，list[str]类型，默认未配置（scope也未配置时表示dump所有api的数据），配置方式参考[《config配置文件说明》](./../../config/README.md) | 否    |
+| online_run_ut    | 在线预检模式开关，bool类型，可取值True（开启）、False（关闭），默认关闭。                                                            | 是    |
+| nfs_path         | 在线预检模式共享存储目录路径，str类型，用于GPU设备和NPU设备间进行通信。配置该参数后host和port不生效。                                            | 否    |
+| host             | 在线预检模式局域网场景信息接收端IP，str类型，用于GPU设备和NPU设备间进行通信，NPU侧须配置为GPU侧的局域网IP地址。局域网场景时，不能配置nfs_path参数，否则局域网场景不生效。     | 否    |
+| port             | 在线预检模式局域网场景信息接收端端口号，int类型，用于GPU设备和NPU设备间进行通信，NPU侧须配置为GPU侧的端口号。局域网场景时，不能配置nfs_path参数，否则局域网场景不生效。        | 否    |
+
+#### 局域网场景配置示例
+
+若复制下列示例，请删除注释后使用。
+
+GPU侧：
+
+```json
+{
+  "task": "run_ut",
+  "run_ut": {
+    "white_list": [],
+    "black_list": [],
+    "error_data_path": "./",
+    "is_online": true,
+    "nfs_path": "",
+    "host": "127.0.0.1",
+    "port": 59208,
+    "rank_list": [0]
+  }
+}
+```
+
+NPU侧：
+
+```json
+{
+  "task": "tensor",
+  "dump_path": "./dump_path",
+  "rank": [0],
+  "step": [0],
+  "level": "L1",
+  "seed": 1234,
+  "is_deterministic": true,
+  "tensor": {
+    "scope": [],
+    "list": [],
+    "online_run_ut": true,
+    "nfs_path": "",
+    "host": "xx.xx.xx.x",
+    "port": 59208
+  }
+}
+```
+
+#### 共享存储场景配置示例
+
+若复制下列示例，请删除注释后使用。
+
+GPU侧：
+
+```json
+{
+  "task": "run_ut",
+  "run_ut": {
+    "white_list": [],
+    "black_list": [],
+    "error_data_path": "./",
+    "is_online": true,
+    "nfs_path": "/nfs/xxx/data",
+    "host": "",
+    "port": -1,
+    "rank_list": [0]
+  }
+}
+```
+
+NPU侧：
+
+```json
+{
+  "task": "tensor",
+  "dump_path": "./dump_path",
+  "rank": [0],
+  "step": [0],
+  "level": "L1",
+  "seed": 1234,
+  "is_deterministic": true,
+  "tensor": {
+    "scope": [],
+    "list": [],
+    "online_run_ut": true,
+    "nfs_path": "/nfs/xxx/data",
+    "host": "",
+    "port": -1
+  }
+}
+```
+
+### 在GPU侧运行run_ut
+
+由于GPU侧为通信接收端，需先于NPU侧执行run_ut操作，命令如下：
+
+```bash
+msprobe -f pytorch run_ut -config ./config.json
+```
+
+GPU侧配置好config.json文件后执行run_ut命令，此时GPU处于预检等待状态：
+
+- 局域网场景：当NPU侧启动训练后将预检的API输入和输出数据发送到GPU侧时，GPU启动预检操作。
+- 共享存储场景：当NPU侧启动训练后将预检的API输入和输出数据发送到共享存储时，GPU启动预检操作。
+
+### 在NPU侧配置训练脚本
+
+在NPU训练脚本中添加如下代码以获取run_ut操作的预检API输入和输出数据：
+
+```python
+from msprobe.pytorch import PrecisionDebugger
+
+debugger = PrecisionDebugger("config.json")
+...
+
+debugger.start()
+
+...
+
+debugger.stop()
+debugger.step()
+```
+
+### 在NPU侧执行训练脚本
+
+配置完NPU侧训练脚本后即可执行训练脚本，命令示例如下：
+
+```bash
+bash train.sh
+```
+
+训练脚本执行完毕后，在GPU侧dump_path目录下生成比对结果文件，详细介绍请参见《[精度预检工具](./api_accuracy_checker.md)》中的”
+**预检结果**“。
+

msprobe/pytorch/doc/dump.md

@@ -12,7 +12,7 @@ msprobe工具主要通过在训练脚本内添加dump接口并启动训练的方
 
 通过加载dump配置文件的方式来确定dump操作的详细配置。
 
-可以在from msprobe.pytorch import PrecisionDebugger和模型初始化之间的任意位置添加该接口。
+PrecisionDebugger接口可以在from msprobe.pytorch import PrecisionDebugger之后的位置添加。详细使用可参考“**示例代码**”或“**model配置代码示例**”。
 
 **原型**
 
@@ -20,7 +20,7 @@ msprobe工具主要通过在训练脚本内添加dump接口并启动训练的方
 PrecisionDebugger(config_path=None, task=None, dump_path=None, level=None, model=None, step=None)
 ```
 
-说明：上述参数除config_path和model外，其他参数均在[config.json](../../config)文件中可配，此处的参数优先级高于[config.json](../../config)文件中的配置，而config.json文件可以配置更多参数，若需要进行更多场景的精度数据dump，建议配置[config.json](../../config)文件。
+说明：上述参数除config_path和model外，其他参数均在[config.json](../../config)文件中可配，此处的参数优先级高于[config.json](../../config)文件中的配置，而config.json文件可以配置更多参数，若需要进行更多场景的精度数据dump，建议配置[config.json](../../config)文件。config.json文件的配置可参考《[配置文件说明](https://gitee.com/ascend/mstt/blob/master/debug/accuracy_tools/msprobe/config/README.md)》。
 
 **参数说明**
 
@@ -77,9 +77,9 @@ if __name__ == "__main__"
 
 **功能说明**
 
-启动函数。
+dump启动函数。
 
-在模型初始化之后的任意位置添加。
+在模型初始化之后的位置添加。需要与stop函数一起添加在for循环内。
 
 **原型**
 
@@ -93,9 +93,9 @@ debugger.start()
 
 **功能说明**
 
-停止函数。
+dump停止函数。
 
-在**start**函数之后的任意位置添加。
+在**start**函数之后的任意位置添加。若需要dump反向数据，则需要添加在反向计算代码（如loss.backward）之后。
 
 **原型**
 
@@ -105,13 +105,33 @@ debugger.stop()
 
 该函数为类函数，可以使用debugger.stop()也可以使用PrecisionDebugger.stop()。
 
+### forward_backward_dump_end函数
+
+**功能说明**
+
+dump停止函数。用于dump指定代码的前反向数据。
+
+在**start**函数之后，反向计算代码（如loss.backward）之前的任意位置添加，可以dump **start**函数和该函数之间的前反向数据，可以通过调整**start**函数与该函数的位置，来指定需要dump的代码块。
+
+要求**stop**函数添加在反向计算代码（如loss.backward）之后，此时该函数与**stop**函数之间的代码不会被dump。
+
+使用示例参见“**示例代码 > 扩展示例**”。
+
+**原型**
+
+```Python
+forward_backward_dump_end()
+```
+
+该函数为类函数，可以使用debugger.forward_backward_dump_end()也可以使用PrecisionDebugger.forward_backward_dump_end()。
+
 ### step函数
 
 **功能说明**
 
 结束标识。
 
-在最后一个**stop**函数后或一个step结束的位置添加。
+在最后一个**stop**函数后或一个step结束的位置添加。需要与start函数一起添加在for循环内。
 
 **原型**
 
@@ -123,24 +143,57 @@ debugger.step()
 
 ## 示例代码
 
+### 基础操作
+
+如下示例可dump完整代码的前反向数据。
+
 ```Python
 from msprobe.pytorch import PrecisionDebugger
+
+# 请勿将PrecisionDebugger的初始化流程插入到循环代码中
 debugger = PrecisionDebugger(config_path="./config.json", dump_path="./dump_path")
-# 请勿将以上初始化流程插入到循环代码中
 
-# 模型初始化
-# 下面代码也可以用PrecisionDebugger.start()和PrecisionDebugger.stop()
-debugger.start()
+# 模型、损失函数的定义及初始化等操作
+# ...
 
-# 需要dump的代码片段1
+# 数据集迭代的位置一般为模型训练开始的位置
+for data, label in data_loader:
+	debugger.start() # 开启数据dump
 
-debugger.stop()
-debugger.start()
+	# 如下是模型每个step执行的逻辑
+    output = model(data)
+    #...
+    loss.backward()
+
+	debugger.stop() # 关闭数据dump
+	debugger.step() # 结束一个step的dump
+```
 
-# 需要dump的代码片段2
+### 扩展示例
 
-debugger.stop()
-debugger.step()
+如下示例dump指定代码块前反向数据。
+
+```Python
+from msprobe.pytorch import PrecisionDebugger
+
+# 请勿将PrecisionDebugger的初始化流程插入到循环代码中
+debugger = PrecisionDebugger(config_path="./config.json", dump_path="./dump_path")
+
+# 模型、损失函数的定义及初始化等操作
+# ...
+
+# 数据集迭代的位置一般为模型训练开始的位置
+for data, label in data_loader:
+	debugger.start() # 开启数据dump
+
+	# 如下是模型每个step执行的逻辑
+    output = model(data)
+    debugger.forward_backward_dump_end() # 插入该函数到start函数之后，只dump start函数到该函数之间代码的前反向数据，本函数到stop函数之间的数据则不dump
+    #...
+    loss.backward()
+
+	debugger.stop() # 关闭数据dump
+	debugger.step() # 结束一个step的dump
 ```
 
 ## dump结果文件介绍
@@ -158,7 +211,7 @@ dump结果目录结构示例如下：
 |   |   |   |    ├── MyModule.0.forward.input.pt        # 开启模块级精度数据dump时存在模块级的dump数据文件
 |   |   |   |    ...
 |   |   |   |    └── Fcuntion.linear.5.backward.output.pt
-│   |   |   ├── dump.json        # 保存前反向算子、算子的统计量信息或溢出算子信息。包含dump数据的API名称（命名格式为：`{api_type}_{api_name}_{API调用次数}_{前向反向}_{input/output}.{参数序号}`）、dtype、 shape、各数据的max、min、mean、L2norm统计信息以及当配置summary_mode="md5"时的md5数据。其中，“参数序号”表示该API下的第n个参数，例如1，则为第一个参数，若该参数为list格式，则根据list继续排序，例如1.1，表示该API的第1个参数的第1个子参数；L2norm表示2范数（平方根）
+│   |   |   ├── dump.json        # 保存前反向算子、算子的统计量信息或溢出算子信息。包含dump数据的API名称（命名格式为：`{api_type}_{api_name}_{API调用次数}_{前向反向}_{input/output}.{参数序号}`）、dtype、 shape、各数据的max、min、mean、L2norm统计信息以及当配置summary_mode="md5"时的md5数据。其中，“参数序号”表示该API下的第n个参数，例如1，则为第一个参数，若该参数为list格式，则根据list继续排序，例如1.1，表示该API的第1个参数的第1个子参数；L2norm表示L2范数（平方根）
 │   |   |   ├── stack.json        # 算子调用栈信息
 │   |   |   └── construct.json        # 分层分级结构
 │   |   ├── rank1
@@ -175,9 +228,9 @@ dump结果目录结构示例如下：
 │   ├── step2
 ```
 
-dump过程中，pt文件在对应算子或者模块被执行后就会落盘，而json文件则需要在正常执行PrecisionDebugger.stop()后才会被落盘保存，异常的程序终止会保存终止前被执行算子的相关pt文件，但是不会生成json文件。
+dump过程中，pt文件在对应算子或者模块被执行后就会落盘，而json文件则需要在正常执行PrecisionDebugger.stop()后才会写入完整数据，异常的程序终止会保存终止前被执行算子的相关npy文件，可能会导致json文件中数据丢失。
 
-其中rank为设备上各卡的ID，每张卡上dump的数据会生成对应dump目录。
+其中rank为设备上各卡的ID，每张卡上dump的数据会生成对应dump目录。非分布式场景下没有rank ID，目录名称为rank。
 
 pt文件保存的前缀和PyTorch对应关系如下：
 

msprobe/pytorch/doc/ptdbg_ascend_compare.md

@@ -1,10 +1,10 @@
 # **精度比对工具**
 
-## CPU或GPU与NPU精度数据比对
+## 总体说明
 
-### 总体说明
+- 本节主要介绍通过命令行方式和比对函数方式进行CPU或GPU与NPU的精度数据比对，执行精度比对操作前需要先完成CPU或GPU与NPU的精度数据dump，参见《[精度数据采集](./dump.md)》。
 
-- 本节主要介绍CPU或GPU与NPU精度数据比对的函数以及示例，执行精度比对操作前需要先完成CPU或GPU与NPU的精度数据dump，详见《[精度数据采集](./dump.md)》。
+- 训练精度一体化工具msprobe，使用子命令compare进行比对，可支持单卡和多卡场景的精度数据比对。
 
 - 比对函数均通过单独创建精度比对脚本执行，可支持单卡和多卡场景的精度数据比对。
 
@@ -12,12 +12,76 @@
 
   用户环境性能弱于标准约束或非独占使用的比对速度酌情向下浮动。比对速度的计算方式：两份比对文件大小/比对耗时。
 
-### 约束
+## 约束
 
 - NPU自研API，在CPU或GPU若没有对应的API，该API的dump数据不比对。
 - NPU与CPU或GPU的计算结果误差可能会随着模型的执行不断累积，最终会出现同一个API因为输入的数据差异较大而无法比对的情况。
 - CPU或GPU与NPU中两个相同的API会因为调用次数不同导致无法比对或比对到错误的API，不影响整体运行，该API忽略。
 
+## 命令行方式比对
+
+将CPU或GPU与NPU的dump文件进行比对，支持单卡和多卡，可同时比对多卡的dump数据。多机场景需要每个设备单独执行比对操作。
+
+请先参见《[精度数据采集](./dump.md)》完成CPU或GPU与NPU的精度数据dump。
+
+### 操作步骤
+
+1. 创建比对文件，文件内容及示例请参见“**比对文件**”。
+
+2. 执行如下示例命令进行比对：
+
+   ```shell
+   msprobe -f pytorch compare -i ./compare.json -o ./output -s
+   ```
+
+   **完整参数说明**
+
+   | 参数名               | 说明                                                                                                                                                                                                 | 是否必选 |
+   |-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------- |
+   | -i或--input_path   | 指定比对文件路径。比对文件内容及示例请参见“**比对文件**”。                                                                                                                                                                   | 是       |
+   | -o或--output_path  | 配置比对结果文件存盘目录。文件名称基于时间戳自动生成，格式为：`compare_result_{timestamp}.xlsx`。                                                                                                                                  | 是       |
+   | -s或--stack_mode   | 配置stack_mode的开关。仅当**比对文件**配置"stack_path"需要开启。通过直接配置该参数开启，默认未配置，表示关闭。                                                                                                                               | 否       |
+   | -c或--compare_only | 仅比对开关。未配置默认关闭仅比对，使用自动精度分析，工具自动针对比对结果进行分析，识别到第一个精度不达标节点（在比对结果文件中的“Accuracy Reached or Not”列显示为No），并给出问题可能产生的原因（打屏展示并生成advisor_{timestamp}.txt文件）。该参数默认未配置，使用自动精度分析，通过配置该参数开启仅比对，关闭自动精度分析，仅输出比对结果表格。 | 否       |
+   | -f或--fuzzy_match  | 模糊匹配。开启后，对于网络中同一层级且命名仅调用次数不同的API，可匹配并进行比对。通过直接配置该参数开启，默认未配置，表示关闭。                                                                                                                                  | 否       |
+
+3. 查看比对结果，请参见“**比对结果分析**”。
+
+### 比对文件
+
+以在当前目录创建./compare.json为例。
+
+- 单卡场景示例
+
+  ```json
+  {
+  "npu_path": "./npu_dump/dump.json",
+  "bench_path": "./bench_dump/dump.json",
+  "stack_path": "./npu_dump/stack.json",
+  "is_print_compare_log": true
+  }
+  ```
+
+- 多卡场景示例
+
+  ```json
+  {
+  "npu_path": "./npu_dump/step0",
+  "bench_path": "./bench_dump/step0",
+  "is_print_compare_log": true
+  }
+  ```
+
+**参数说明**
+
+| 参数名               | 说明                                                         | 是否必选           |
+| -------------------- | ------------------------------------------------------------ | ------------------ |
+| npu_path             | 配置NPU环境下的dump.json文件（单卡场景）或真实数据目录（多卡场景）。数据类型：str。 | 是                 |
+| bench_path           | 配置CPU、GPU或NPU环境下的dump.json文件（单卡场景）或真实数据目录（多卡场景）。数据类型：str。 | 是                 |
+| stack_path           | 配置NPU dump目录下的stack.json文件。数据类型：str。          | 单卡必选，多卡不选 |
+| is_print_compare_log | 配置是否开启日志打屏。可取值True或False。数据类型：bool      | 否                 |
+
+## 比对函数方式比对
+
 ### compare_distributed
 
 **功能说明**
@@ -66,7 +130,7 @@ compare(input_param, output_path, stack_mode=False, auto_analyze=True, fuzzy_mat
 
 | 参数名       | 说明                                                         | 是否必选 |
 | ------------ | ------------------------------------------------------------ | -------- |
-| input_param  | 配置dump数据文件及目录。数据类型：dict。配置参数包括：<br>        "npu_json_path"：指定NPU dump目录下的dump.json文件。参数示例："npu_json_path": "./npu_dump/dump.json"。必选。<br/>        "bench_json_path"：指定CPU、GPU或NPU dump目录下的dump.json文件。参数示例："bench_json_path": "./gpu_dump/dump.json"。必选。<br/>        "stack_json_path"：指定NPU dump目录下的stack.json文件。参数示例："stack_json_path": "./npu_dump/stack.json"。可选。<br/>        "is_print_compare_log"：配置是否开启日志打屏。可取值True或False。可选。 | 是       |
+| input_param  | 配置dump数据文件及目录。数据类型：dict。配置参数包括：<br>        "npu_json_path"：指定NPU dump目录下的dump.json文件。参数示例："npu_json_path": "./npu_dump/dump.json"。必选。<br/>        "bench_json_path"：指定CPU、GPU或NPU dump目录下的dump.json文件。参数示例："bench_json_path": "./bench_dump/dump.json"。必选。<br/>        "stack_json_path"：指定NPU dump目录下的stack.json文件。参数示例："stack_json_path": "./npu_dump/stack.json"。可选。<br/>        "is_print_compare_log"：配置是否开启日志打屏。可取值True或False。可选。 | 是       |
 | output_path  | 配置比对结果文件存盘目录。参数示例：'./output'。文件名称基于时间戳自动生成，格式为：`compare_result_{timestamp}.xlsx`。数据类型：str。 | 是       |
 | stack_mode   | 配置stack_mode的开关。仅当配置"stack_json_path"需要开启。可取值True或False，参数示例：stack_mode=True，默认为False。数据类型：bool。 | 否       |
 | auto_analyze | 自动精度分析，开启后工具自动针对比对结果进行分析，识别到第一个精度不达标节点（在比对结果文件中的“Accuracy Reached or Not”列显示为No），并给出问题可能产生的原因（打屏展示并生成advisor_{timestamp}.txt文件）。可取值True或False，参数示例：auto_analyze=False，默认为True。数据类型：bool。 | 否       |
@@ -78,13 +142,13 @@ compare(input_param, output_path, stack_mode=False, auto_analyze=True, fuzzy_mat
 
 ```Python
 from msprobe.pytorch import compare
-dump_result_param={
+input_param={
 "npu_json_path": "./npu_dump/dump.json",
-"bench_json_path": "./gpu_dump/dump.json",
+"bench_json_path": "./bench_dump/dump.json",
 "stack_json_path": "./npu_dump/stack.json",
 "is_print_compare_log": True
 }
-compare(dump_result_param, output_path="./output", stack_mode=True)
+compare(input_param, output_path="./output", stack_mode=True)
 ```
 
 ### 统计量比对
@@ -97,13 +161,13 @@ compare(dump_result_param, output_path="./output", stack_mode=True)
 
 ```Python
 from msprobe.pytorch import compare
-dump_result_param={
+input_param={
 "npu_json_path": "./npu_dump/dump.json",
-"bench_json_path": "./gpu_dump/dump.json",
+"bench_json_path": "./bench_dump/dump.json",
 "stack_json_path": "./npu_dump/stack.json",
 "is_print_compare_log": True
 }
-compare(dump_result_param, output_path="./output", stack_mode=True)
+compare(input_param, output_path="./output", stack_mode=True)
 ```
 
 **比对结果**

msprobe/pytorch/doc/ptdbg_ascend_quickstart.md

@@ -83,13 +83,13 @@ PyTorch训练场景的精度问题分析建议参考以下思路进行精度比
 
    ```python
    from msprobe.pytorch import compare
-   dump_result_param={
+   input_param={
    "npu_json_path": "./npu_dump/dump.json",
-   "bench_json_path": "./gpu_dump/dump.json",
+   "bench_json_path": "./bench_dump/dump.json",
    "stack_json_path": "./npu_dump/stack.json",
    "is_print_compare_log": True
    }
-   compare(dump_result_param, output_path="./output", stack_mode=True)
+   compare(input_param, output_path="./output", stack_mode=True)
    ```
    
    执行比对：

msprobe/pytorch/doc/run_overflow_check.md

@@ -2,7 +2,7 @@
 
 针对训练过程中的溢出检测场景（当《[精度数据采集](./dump.md)》开启溢出检测dump时），对于输入正常但输出存在溢出的API，会在训练执行目录下将溢出的API信息按照前向和反向分类，dump并保存为`dump.json`，前向过程溢出的API可通过该工具对`dump.json`进行解析，输出溢出API为正常溢出还是非正常溢出，从而帮助用户快速判断。
 
-工具支持PyTorch版本：1.11.0/2.0/2.1/2.2。
+工具支持PyTorch版本：1.11/2.0/2.1/2.2。
 
 操作步骤如下：