mindstudio-probe 1.0.4__py3-none-any.whl → 1.1.1__py3-none-any.whl

msprobe/docs/02.config_introduction.md

@@ -3,24 +3,21 @@
 - 当调用 **PrecisionDebugger** 接口执行 dump 或其他操作时，需要使用 [config.json](../config.json) 文件；当未指定 config.json 时，将使用默认配置。
 - msprobe 成功安装后，config.json 一般位于如下目录：
 ```
-/home/***/miniconda3/envs/***/lib/python3.8/site-packages/msprobe/
+/home/xxx/miniconda3/envs/xxx/lib/python3.xx/site-packages/msprobe/
 ```
 
 ## 1 参数介绍
 
 ### 1.1 通用配置
 
-| 参数名    | 解释    | 是否必选 |
-| ----------------- | ---------------- | -------- |
-| task              | dump 的任务类型，str 类型。可取值，<br/>  "statistics"：仅 dump API 统计信息，默认值；<br/> "tensor"：dump API 统计信息和完全复刻整网的 API 运行情况的真实数据；<br/> "run_ut"：精度预检，仅 PyTorch 场景支持。<br/> "overflow_check"：溢出检测，仅 PyTorch 和 MindSpore 静态图场景支持；<br/>  "free_benchmark"：无标杆比对；<br/>    根据 task 参数取值的不同，可以配置不同场景参数，详见：<br/>[1.2 task 配置为 statistics](#12-task-配置为-statistics)，<br/>[1.3 task 配置为 tensor](#13-task-配置为-tensor)，<br/>[1.4 task 配置为 run_ut](#14-task-配置为-run_ut)，<br/>[1.5 task 配置为 overflow_check](#15-task-配置为-overflow_check)，<br/>[1.6 task 配置为 free_benchmark](#16-task-配置为-free_benchmark)。 <br/>  **配置示例**："task": "tensor"。  | 否       |
-| dump_path         | 设置 dump 数据目录路径，str 类型。<br/>  **配置示例**："dump_path": "./dump_path"。MindSpore 场景仅支持绝对路径。 | 是       |
-| rank              | 指定对某张卡上的数据进行 dump，list[int] 类型，默认未配置（表示 dump 所有卡的数据），应配置为 ≥0 的整数，且须配置实际可用的 Rank ID。<br/>  <hr>PyTorch 场景：Rank ID 从 0 开始计数，最大取值为所有节点可用卡总数-1，若所配置的值大于实际训练所运行的卡的 Rank ID，则 dump 数据为空，比如当前环境 Rank ID 为 0 到 7，实际训练运行 0 到 3 卡，此时若配置 Rank ID 为 4 或不存在的 10 等其他值，dump 数据为空。<br/>  **配置示例**："rank": [1]。<hr> MindSpore 场景：所有节点的 Rank ID 均从 0 开始计数，最大取值为每个节点可用卡总数-1，config.json 配置一次 rank 参数对所有节点同时生效。<br/>  **配置示例**："rank": [1]。 | 否       |
-| step              | 指定 dump 某个 step 的数据，list[int] 类型。默认未配置，表示 dump 所有 step 数据。dump 特定 step 时，须指定为训练脚本中存在的 step。step 为 list 格式，可配置逐个 step。<br/>  **配置示例**："step": [0,1,2]。 | 否       |
-| level             | dump 级别，str 类型，根据不同级别 dump 不同数据。可取值，<br/>"L0"：dump 模块级精度数据，仅 PyTorch 与 MindSpore 动态图场景支持，使用背景详见 [1.1.1 模块级精度数据 dump 说明](#111-模块级精度数据-dump-说明)；<br/>"L1"：dump API 级精度数据，默认值，仅 PyTorch 与 MindSpore 动态图场景支持；<br/>"L2"：dump kernel 级精度数据，PyTorch场景下须配置 acl_config 参数；<br/>"mix"：dump module 模块级和 API 级精度数据，即"L0"+"L1"，仅 PyTorch 场景支持。<br/>  **配置示例**："level": "L1"。 | 否 |
-| acl_config        | kernel dump 的配置文件，str 类型。level 取"L2"时，该参数必要；level 为其他值时，该参数不选。<br/> **配置示例**：acl_config="./acl_config.json"。具体配置见[ acl_config 示例](./04.acl_config_examples.md)。 | 否       |
-| seed              | 随机种子数，int 类型，默认值为：1234，仅 PyTorch 场景支持。通过固定随机数保证模型的输入或输出一致，可固定的随机数详见 [1.1.2 固定随机数范围（仅 PyTorch 场景支持）](#112-固定随机数范围仅-pytorch-场景支持)。<br/>  **配置示例**："seed": 1234。 | 否       |
-| is_deterministic  | 确定性计算模式，bool 类型，仅 PyTorch 场景支持。可取值 true（开启）或 false（关闭），默认关闭。<br/>  即使在相同的硬件和输入下，API 多次执行的结果也可能不同，开启确定性计算是为了保证在相同的硬件和输入下，API 多次执行的结果相同。<br/>确定性计算会导致 API 执行性能降低，建议在发现模型多次执行结果不同的情况下开启。<br/> rnn 类算子、ReduceSum、ReduceMean 等算子可能与确定性计算存在冲突，若开启确定性计算后多次执行的结果不相同，则考虑存在这些算子。<br/>  **配置示例**："is_deterministic": true。<br/>  | 否       |
-| enable_dataloader | 自动控制开关，bool 类型，仅 PyTorch 场景支持。可取值 true（开启）或 false（关闭），默认为 false。配置为 True 后自动识别 step 参数指定的迭代，并在该迭代执行完成后退出训练，此时 start、stop 和 step 函数可不配置，开启该开关要求训练脚本是通过 torch.utils.data.dataloader 方式加载数据。仅支持 PyTorch 单卡训练使用，分布式训练场景下存在数据 dump 不全问题，**下个版本即将废弃该功能**。 | 否       |
+| 参数    | 解释                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | 是否必选 |
+| ----------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------- |
+| task              | dump 的任务类型，str 类型。可选参数：<br/>  "statistics"：仅采集统计信息，默认值；<br/> "tensor"：采集统计信息和完全复刻整网的真实数据；<br/> "run_ut"：精度预检，仅 PyTorch 场景支持，采集数据时勿选；<br/> "overflow_check"：溢出检测；<br/>  "free_benchmark"：无标杆比对；<br/>  "grad_probe"：梯度监控。<br/>    根据 task 参数取值的不同，可以配置不同场景参数，详见：<br/>[1.2 task 配置为 statistics](#12-task-配置为-statistics)，<br/>[1.3 task 配置为 tensor](#13-task-配置为-tensor)，<br/>[1.4 task 配置为 run_ut](#14-task-配置为-run_ut)，<br/>[1.5 task 配置为 overflow_check](#15-task-配置为-overflow_check)，<br/>[1.6 task 配置为 free_benchmark](#16-task-配置为-free_benchmark)，<br/>[1.7 task 配置为 grad_probe](#17-task-配置为-grad_probe)。 <br/>  **配置示例**："task": "tensor"。 | 否       |
+| dump_path         | 设置 dump 数据目录路径，str 类型。<br/>  **配置示例**："dump_path": "./dump_path"。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | 是       |
+| rank              | 指定对某张卡上的数据进行采集，list[Union[int, str]] 类型，默认未配置（表示采集所有卡的数据），应配置元素为 ≥0 的整数或类似"4-6"的字符串，且须配置实际可用的 Rank ID。<br/>  PyTorch 场景: Rank ID 从 0 开始计数，最大取值为所有节点可用卡总数-1，若所配置的值大于实际训练所运行的卡的 Rank ID，则 dump 数据为空，比如当前环境 Rank ID 为 0 到 7，实际训练运行 0 到 3 卡，此时若配置 Rank ID 为 4 或不存在的 10 等其他值，dump 数据为空。<br/>  MindSpore 场景：所有节点的 Rank ID 均从 0 开始计数，最大取值为每个节点可用卡总数-1，config.json 配置一次 rank 参数对所有节点同时生效。<br/> 注意，单卡训练时，rank必须为[]，即空列表，不能指定rank。<br/>**配置示例**："rank": [1, "4-6"]。                                                                                                       | 否       |
+| step              | 指定采集某个 step 的数据，list[Union[int, str]] 类型。默认未配置，表示采集所有 step 数据。采集特定 step 时，须指定为训练脚本中存在的 step，可逐个配置，也可以指定范围。<br/>  **配置示例**："step": [0, 1 , 2, "4-6"]。                                                                                                                                                                                                                                                                                                                                                                                                            | 否       |
+| level             | dump 级别，str 类型，根据不同级别采集不同数据。可选参数：<br/>"L0"：dump 模块级精度数据，仅 PyTorch 与 MindSpore 动态图场景支持，使用背景详见 [1.1.1 模块级精度数据 dump 说明](#111-模块级精度数据-dump-说明)；<br/>"L1"：dump API 级精度数据，默认值，仅 PyTorch 与 MindSpore 动态图场景支持；<br/>"L2"：dump kernel 级精度数据，PyTorch场景详细介绍见 [PyTorch 场景的 kernel dump 说明](./04.kernel_dump_PyTorch.md)；<br/>"mix"：dump module 模块级和 API 级精度数据，即"L0"+"L1"，仅 PyTorch 与 MindSpore 动态图场景支持。<br/>  **配置示例**："level": "L1"。                                                                                                                                                    | 否 |
+| enable_dataloader | 自动控制开关，bool 类型，仅 PyTorch 场景支持。可选参数 true（开启）或 false（关闭），默认为 false。配置为 true 后自动识别 step 参数指定的迭代，并在该迭代执行完成后退出训练，此时 start、stop 和 step 函数可不配置，开启该开关要求训练脚本是通过 torch.utils.data.dataloader 方式加载数据。仅支持 PyTorch 单卡训练使用，分布式训练场景下存在数据 dump 不全问题。 **这个特性下个版本将被废弃**                                                                                                                                                                                                                                                                                                           | 否       |
 
 #### 1.1.1 模块级精度数据 dump 说明
 
@@ -32,79 +29,49 @@
 
 模块指的是继承 nn.Module 类（PyTorch场景）或 nn.Cell 类（MindSpore场景）的子类，通常情况下这类模块就是一个小模型，可以被视为一个整体，dump 数据时以模块为粒度进行 dump。
 
-#### 1.1.2 固定随机数范围（仅 PyTorch 场景支持）
-
-seed_all 函数可固定随机数的范围如下表。
-
-| API                                      | 固定随机数                  |
-| ---------------------------------------- | --------------------------- |
-| os.environ['PYTHONHASHSEED'] = str(seed) | 禁止 Python 中的 hash 随机化 |
-| random.seed(seed)                        | 设置 random 随机生成器的种子  |
-| np.random.seed(seed)                     | 设置 numpy 中随机生成器的种子 |
-| torch.manual_seed(seed)                  | 设置当前 CPU 的随机种子       |
-| torch.cuda.manual_seed(seed)             | 设置当前 GPU 的随机种子       |
-| torch.cuda.manual_seed_all(seed)         | 设置所有 GPU 的随机种子       |
-| torch_npu.npu.manual_seed(seed)          | 设置当前 NPU 的随机种子       |
-| torch_npu.npu.manual_seed_all(seed)      | 设置所有 NPU 的随机种子       |
-| torch.backends.cudnn.enable=False        | 关闭 cuDNN                   |
-| torch.backends.cudnn.benchmark=False     | cuDNN 确定性地选择算法       |
-| torch.backends.cudnn.deterministic=True  | cuDNN 仅使用确定性的卷积算法 |
-
-需要保证 CPU 或 GPU 以及 NPU 的模型输入完全一致，dump 数据的比对才有意义，seed_all 并不能保证模型输入完全一致，如下表所示场景需要保证输入的一致性。
-
-| 场景            | 固定方法      |
-| --------------- | ------------- |
-| 数据集的 shuffle | 关闭 shuffle。 |
-| dropout         | 关闭 dropout。 |
-
-关闭 shuffle 示例：
-
-```python
-train_loader = torch.utils.data.DataLoader(
-train_dataset,
-batch_size = batch_size,
-shuffle = False,
-num_workers = num_workers
-)
-```
-
-关闭 dropout：
-
-在使用 `from msprobe.pytorch import PrecisionDebugger` 后，工具会自动将 `torch.nn.functional.dropout`、`torch.nn.functional.dropout2d`、`torch.nn.functional.dropout3d`、`torch.nn.Dropout`、`torch.nn.Dropout2d`、`torch.nn.Dropout3d` 的接口参数 p 置为0。
-
 ### 1.2 task 配置为 statistics
 
-| 参数名       | 解释               | 是否必选 |
-| ------------ | ------------------- | -------- |
-| scope        | PyTorch 和 MindSpore 动态图场景 dump 范围，list[str] 类型，默认未配置（list 也未配置时表示 dump 所有 API 的数据）。该参数在 [ ] 内配置两个模块名或 API 名，用于锁定区间，dump 该范围内的数据。<br/>**配置示例**："scope": ["MyModuleOP1", "MyModuleOP2"]。与 level 参数取值相关，level 为 L0 和 mix 级别时，可配置模块名；level 为 L1 级别时，可配置 API 名。MindSpore 动态图场景当前仅支持配置为 API 名。  | 否       |
-| list         | 自定义 dump 范围，list[str] 类型，默认未配置（scope 也未配置时表示 dump 所有 API 的数据）。包含如下配置方法：<br>        PyTorch 和 MindSpore 动态图场景配置具体的 API 全称，dump 该 API 数据。<br/>**配置示例**："list": ["Tensor.permute.1.forward", "Tensor.transpose.2.forward", "Torch.relu.3.backward"]。<br/>  <hr>      PyTorch 和 MindSpore 动态图场景指定某一类 API，dump 某一类的 API 级别输入输出数据。<br/>**配置示例**："list": ["relu"]。<hr> MindSpore 静态图场景配置 kernel_name，可以是算子的名称列表，也可以指定算子类型（"level": "L2"时不支持），还可以配置算子名称的正则表达式（当字符串符合“name-regex(xxx)”格式时，后台则会将其作为正则表达式。例如，“name-regex(Default/.+)”可匹配算子名称以“Default/”开头的所有算子）。 | 否      |
-| data_mode    | dump 数据过滤，str 类型。<br/><hr>PyTorch 场景：支持"all"、"forward"、"backward"、"input"和"output"，表示仅保存 dump 的数据中文件名包含"forward"、"backward"、"input"和"output"的前向、反向、输入或输出的 dump 文件。<br/> **配置示例**："data_mode": ["all"]。 <hr>MindSpore 场景：仅支持"all"、"input"和"output"参数，且各参数只能单独配置，不支持自由组合。<br/>**配置示例**："data_mode": ["backward"] 或 "data_mode": ["forward", "backward"]。默认为["all"]，即保存所有 dump 的数据。除了 all 参数只能单独配置外，其他参数可以自由组合。 | 否       |
-| summary_mode | 控制 dump 文件输出的模式，str 类型，仅 PyTorch 场景支持，可取值，<br/> md5：dump 输出包含 md5 值以及 API 统计信息的 dump.json 文件，用于验证数据的完整性；<br/> statistics：dump 仅输出包含 API 统计信息的 dump.json 文件，默认值。<br/> **配置示例**："summary_mode": "md5"。 | 否       |
+<table>
+    <tr><th>参数</th><th>解释</th><th>是否必选</th></tr>
+    <tr><td>scope</td><td>PyTorch 和 MindSpore 动态图场景 dump 范围，list[str] 类型，默认未配置（list 也未配置时表示 dump 所有 API 的数据）。该参数可以在 [ ] 内配置两个模块名或 API 名，要求列表长度必须为2，需要配置按照工具命名格式的完整模块名或API名称，用于锁定区间，dump 该范围内的数据。<br/><b>配置示例</b>：  
+    "scope": ["Module.conv1.Conv2d.forward.0", "Module.fc2.Linear.forward.0"],                             
+    或 "scope": ["Cell.conv1.Conv2d.forward.0", "Cell.fc2.Dense.backward.0"], 或"scope": ["Tensor.add.0.forward", "Functional.square.2.forward"]。与 level 参数取值相关，level 为 L0 级别时，可配置模块名；level 为 L1 级别时，可配置 API 名， level为 mix 级别时，可配置为模块名或API名。</td><td>否</td></tr>
+    <tr><td rowspan="4">list</td><td>自定义采集的算子列表，list[str] 类型，默认未配置（scope 也未配置时表示 dump 所有 API 的数据），包含以下配置方法：</td><td rowspan="4">否</td></tr>
+    <tr><td>PyTorch 和 MindSpore 动态图场景配置具体的 API 全称，dump 该 API 数据。在 PyTorch 场景，如果 level 配置成 L2，该配置为必填项。<br/><b>配置示例</b>："list": ["Tensor.permute.1.forward", "Tensor.transpose.2.forward", "Torch.relu.3.backward"]。<br/> PyTorch 和 MindSpore 动态图场景在level为 mix 级别时可以配置模块名称，dump该模块展开数据 （dump该模块执行前到执行期间结束所有的数据）。
+    <br/><b>配置示例</b>："list": ["Module.module.language_model.encoder.layers.0.mlp.ParallelMlp.forward.0"], 或 "list": ["Cell.network_with_loss.language_model.encoder.layers.0.mlp.ParallelMlp.forward.0"]</td></tr>
+    <tr><td>PyTorch 和 MindSpore 动态图场景指定某一类 API，dump 某一类的 API 级别输入输出数据。<br/><b>配置示例</b>："list": ["relu"]。 <br/>    PyTorch 和 MindSpore 动态图场景在level为 mix 级别时, 会dump名称中包含list中配置的字符串的API数据，还会将名称中包含list中配置的字符串的模块进行展开dump （dump该模块执行前到执行期间结束所有的数据）。</td></tr> 
+    <tr><td>MindSpore 静态图场景配置 kernel_name，可以是算子的名称列表，也可以指定算子类型（"level": "L2"时不支持），还可以配置算子名称的正则表达式（当字符串符合“name-regex(xxx)”格式时，后台则会将其作为正则表达式。<br/><b>配置示例</b>：list: ["name-regex(Default/.+)"]<br/>可匹配算子名称以“Default/”开头的所有算子。</td></tr>
+    <tr><td rowspan="3">data_mode</td><td>dump 数据过滤，str 类型。</td><td rowspan="3">否</td></tr>
+    <tr><td>PyTorch 与 MindSpore 动态图场景：支持"all"、"forward"、"backward"、"input"和"output"，除"all"外，其余参数可以自由组合。默认为["all"]，即保存所有 dump 的数据。<br/> <b>配置示例</b>："data_mode": ["backward"] （仅保存反向数据）或 "data_mode": ["forward", "input"]（仅保存前向的输入数据）。</td></tr>
+    <tr><td>MindSpore 静态图场景：仅支持"all"、"input"和"output"参数，且各参数只能单独配置，不支持自由组合。<br/><b>配置示例</b>："data_mode": ["all"]。</td></tr>
+    <tr><td>summary_mode</td><td>控制 dump 文件输出的模式，str 类型，仅 PyTorch 与 MindSpore 动态图场景支持，可选参数：<br/> md5：dump 输出包含 CRC-32 值以及 API 统计信息的 dump.json 文件，用于验证数据的完整性；<br/> statistics：dump 仅输出包含 API 统计信息的 dump.json 文件，默认值。<br/><b>配置示例</b>："summary_mode": "md5"。</td><td>否</td></tr>
+</table>
+
+**说明**："summary_mode"配置为"md5"时，所使用的校验算法为CRC-32算法。
 
 ### 1.3 task 配置为 tensor
 
-| 参数名         | 解释         | 是否必选 |
+| 参数         | 解释         | 是否必选 |
 | -------------- | ---------------------- | -------- |
 | scope          | 与[ 1.2 task 配置为 statistics ](#12-task-配置为-statistics)中的解释相同。 | 否       |
-| list           | 与[ 1.2 task 配置为 statistics ](#12-task-配置为-statistics)中的解释相同。另外，<br/> PyTorch 和 MindSpore 动态图场景配置 kernel_api，dump 前向和反向 API 的kernel_api 级别数据，其中 dump 反向 API 时需要配置 **backward_input** 参数。<br/>**前向 API 配置示例**："list": ["Tensor.permute.1.forward"]；<br/>**反向 API 配置示例**："list": ["Tensor.permute.1.forward"], "backward.input": ["./npu_dump/step0/rank0/Functional.conv2d.1.backward.input.0.pt"]。<br/> | 否       |
-| backward_input | 该输入文件为首次运行训练 dump 得到反向 API 输入的 dump 文件，str 类型，仅 PyTorch 场景支持，默认未配置。例如若需要 dump Functional.conv2d.1 API 的反向过程的输入输出，则需要在 dump 目录下查找命名包含 Functional.conv2d.1、backward 和 input 字段的 dump 文件。<br/>**配置示例**："backward_input": ["./npu_dump/step0/rank0/Functional.conv2d.1.backward.input.0.pt"] | 否       |
+| list           | 与[ 1.2 task 配置为 statistics ](#12-task-配置为-statistics)中的解释相同。 | 否       |
 | data_mode      | 与[ 1.2 task 配置为 statistics ](#12-task-配置为-statistics)中的解释相同 | 否       |
-| file_format    | MindSpore 静态图场景 tensor 数据的保存格式，str 类型，可取值，<br/> "bin"：dump 的 tensor 文件为二进制格式，"level": "L1" 时不支持；<br/>"npy"：dump 的 tensor 文件后缀为 .npy，默认值。 | 否       |
-| online_run_ut<sup>a<sup/>  | 在线预检模式开关，bool 类型，可取值 true（开启）、false（关闭），默认未配置，表示关闭。配置为 true 表示开启在线预预检。| 否 |
-| nfs_path<sup>a<sup/> | 在线预检模式共享存储目录路径，str 类型，用于 GPU 设备和 NPU 设备间进行通信。仅在 online_run_ut 字段配置为 true 时生效，未配置该参数后 host 和 port 不生效。 | 否 |
-| host<sup>a<sup/> | 在线预检模式局域网场景信息接收端 IP，str 类型，用于 GPU 设备和 NPU 设备间进行通信，NPU 侧须配置为 GPU 侧的局域网 IP 地址。仅在 online_run_ut 字段配置为 true 时生效，局域网场景时，不能配置 nfs_path 参数，否则局域网场景不生效。 | 否 |
-| port<sup>a<sup/> | 在线预检模式局域网场景信息接收端端口号，int 类型，用于 GPU 设备和 NPU 设备间进行通信，NPU 侧须配置为 GPU 侧的端口号。仅在 online_run_ut 字段配置为 true 时生效，局域网场景时，不能配置 nfs_path 参数，否则局域网场景不生效。| 否 |
+| file_format    | tensor 数据的保存格式，str 类型，仅支持 MindSpore 静态图场景的 L2，不支持 L0 和 L1。可选参数：<br/> "bin"：dump 的 tensor 文件为二进制格式；<br/>"npy"：dump 的 tensor 文件后缀为 .npy，默认值。 | 否       |
+| online_run_ut<sup>a</sup>  | 在线预检模式开关，bool 类型，可选参数 true（开启）、false（关闭），默认未配置，表示关闭。配置为 true 表示开启在线预检。| 否 |
+| nfs_path<sup>a</sup> | 在线预检模式共享存储目录路径，str 类型，用于 GPU 设备和 NPU 设备间进行通信。仅在 online_run_ut 字段配置为 true 时生效，配置该参数后 host 和 port 不生效。 | 否 |
+| host<sup>a</sup> | 在线预检模式局域网场景信息接收端 IP，str 类型，用于 GPU 设备和 NPU 设备间进行通信，NPU 侧须配置为 GPU 侧的局域网 IP 地址。仅在 online_run_ut 字段配置为 true 时生效，局域网场景时，不能配置 nfs_path 参数，否则局域网场景不生效。 | 否 |
+| port<sup>a</sup> | 在线预检模式局域网场景信息接收端端口号，int 类型，用于 GPU 设备和 NPU 设备间进行通信，NPU 侧须配置为 GPU 侧的端口号。仅在 online_run_ut 字段配置为 true 时生效，局域网场景时，不能配置 nfs_path 参数，否则局域网场景不生效。| 否 |
 
 **a**：online_run_ut、nfs_path、host、port 等字段仅在线预检场景 NPU 机器生效。
 
 ### 1.4 task 配置为 run_ut
 
-| 参数名称        | 解释                   | 是否必选 |
+| 参数        | 解释                   | 是否必选 |
 | --------------- | ------------------------ | ------------ |
 | white_list<sup>a</sup>      | API dump 白名单，仅对指定的 API 进行 dump。<br/>**配置示例**："white_list": ["conv1d", "conv2d"]。默认未配置白名单，即 dump 全量 API 数据。 | 否       |
 | black_list<sup>a</sup>      | API dump 黑名单，被指定的 API 不进行 dump。<br/>**配置示例**："black_list": ["conv1d", "conv2d"]。默认未配置黑名单，即 dump 全量 API 数据。 | 否       |
 | error_data_path | 配置保存精度未达标的 API 输入输出数据路径，默认为当前路径。<br/>**配置示例**："error_data_path": "./"。 | 否       |
-| is_online<sup>b</sup>       | 在线预检模式开关，bool 类型，可取值 true（开启）、false（关闭），默认关闭。 | 否 |
+| is_online<sup>b</sup>       | 在线预检模式开关，bool 类型，可选参数 true（开启）、false（关闭），默认关闭。 | 否 |
 | nfs_path<sup>b</sup>        | 在线预检模式共享存储目录路径，str 类型，用于 GPU 设备和 NPU 设备间进行通信。配置该参数后 host 和 port 不生效，仅在 is_online 字段配置为 true 时生效。 | 否    |
 | host<sup>b</sup>            | 在线预检模式局域网场景信息接收端 IP，str 类型，用于 GPU 设备和 NPU 设备间进行通信，GPU 侧配置为本机地址 127.0.0.1 或本机局域网 IP。局域网场景时，不能配置 nfs_path 参数，否则局域网场景不生效。仅在 is_online 字段配置为 true 时生效。 | 否 |
 | port<sup>b</sup>            | 在线预检模式局域网场景信息接收端端口号，int 类型，用于 GPU 设备和 NPU 设备间进行通信，GPU 侧配置为本机可用端口。局域网场景时，不能配置 nfs_path 参数，否则局域网场景不生效。仅在 is_online 字段配置为 true 时生效。| 否 |
@@ -116,12 +83,12 @@ num_workers = num_workers
 
 ### 1.5 task 配置为 overflow_check
 
-PyTorch 与 MindSpore 动态图场景下，"level"须为"L1"；MindSpore 静态图场景下，"level"须为"L2"。
+PyTorch 与 MindSpore 动态图场景下，"level"须为"L0"或"L1"；MindSpore 静态图场景下，"level"须为"L2"，且模型编译优化等级（jit_level）须为"O2"。
 
-| 参数名        | 解释                 | 是否必选 |
+| 参数        | 解释                 | 是否必选 |
 | ------------- | ---------------------- | -------- |
 | overflow_nums | 最大溢出次数，int 类型，默认为 1，仅 PyTorch 与 MindSpore 动态图场景支持。表示第 N 次溢出后，不再进行溢出检测。过程中检测到溢出 API 对应的 输入输出 数据均 dump。<br/>**配置示例**："overflow_nums": 3。配置为 -1 时，表示持续检测溢出直到训练结束。 | 否       |
-| check_mode    | MindSpore 静态图场景 kernel 级别的溢出检测，str 类型，可取值：<br/>"aicore"：开启 AI Core 的溢出检测；<br/>"atomic"：开启 Atomic 的溢出检测；<br/>"all"：开启 AI Core 和 Atomic 的溢出检测，默认值。<br/>**配置示例**："check_mode": "aicore"。 | 否       |
+| check_mode    | 溢出类型，str 类型，仅 MindSpore 场景支持，可选参数：<br/>"aicore"：开启 AI Core 的溢出检测，不支持 MindSpore v2.3.0 以上版本；<br/>"atomic"：开启 Atomic 的溢出检测，不支持 MindSpore v2.3.0 以上版本；<br/>"all"：开启算子的溢出检测，默认值。<br/>**配置示例**："check_mode": "all"。 | 否       |
 
 ### 1.6 task 配置为 free_benchmark
 
@@ -133,18 +100,21 @@ PyTorch 与 MindSpore 动态图场景下，"level"须为"L1"；MindSpore 静态
 
 - 建议配置白名单（配置 scope 或 list）控制少量 API 进行无标杆比对，一次对过多 API 执行无标杆比对可能导致显存溢出或性能膨胀。
 
-| 参数名       | 解释               | 是否必选 |
-| ------------ | -------------- | -------- |
-| scope        | 自定义检测 API 列表（仅 PyTorch 场景支持），list[str] 类型，默认值为空列表，当 list 也为空列表时，表示检测所有 API。需要在 [ ] 内配置具体 API 名（在 dump 的结果中查看）。<br/>**配置示例**："scope": ["Torch.matmul.0", "Tensor.pow.4"]。<br/>与 list 参数不能同时配置。 | 否       |
-| list         | 自定义检测 API 类型或 API 名称，list[str] 类型，默认值为空列表，表示检测所有 API（PyTorch 场景下还需 scope 也为空列表）。<br><hr>        PyTorch 场景：指定某一类 API，对某一类的 API 进行无标杆比对。<br/>**配置示例**："list": ["relu"]。<br/> <hr>       MindSpore 场景：指定 API 名称，对列表中的 API 进行检测。<br/>**配置示例**："list": ["mindspore.mint.div", "mindspore.ops.bmm", "mindspore.Tensor.\_\_add\_\_"]。<br/>与 scope 参数不能同时配置。 | 否       |
-| fuzz_device  | 标杆设备，str 类型。可取值，<br/>        "npu"：无标杆，通过添加扰动因子进行比对，默认值；<br/>        "cpu"：以 CPU 为标杆，pert_mode 须配置为"to_cpu"（仅 PyTorch 场景支持）。<br/>**配置示例**："fuzz_device": "cpu"。 | 否       |
-| pert_mode    | 无标杆扰动因子，str 类型。可取值，<br/>  "improve_precision"：对输入做升精度，默认值；<br/>        "add_noise"：对输入增加噪声；<br/>        "no_change"：不加扰动直接二次执行；<br/>        "bit_noise"：输入的末位比特翻转；<br/>        "change_value"：输入的张量首尾值调换（仅 PyTorch 场景支持）；<br/>        "to_cpu"：在 CPU 等价执行（仅 PyTorch 场景支持）。<br/>**配置示例**："pert_mode": "improve_precision"。 | 否       |
-| handler_type | 处理类型，可取值，<br/> "check"：进行无标杆比对检查，默认值；<br/> "fix"：将扰动后的 API 输出结果覆盖原始 API 输出结果，尝试将 Loss 曲线恢复正常，该模式下不支持预热 if_preheat。<br/> **配置示例**："handler_type": "fix"。 | 否       |
-| fuzz_level   | 无标杆数据 dump 级别，即选择比对结果文件应输出的表头属性，当前仅支持取值为："L1"。输出结果详见 [1.6.1 无标杆比对数据存盘格式]()。 | 否       |
-| fuzz_stage   | 前反向，选择对 API 前向或反向进行无标杆比对，可取值：<br/> "forward"：前向，默认值；<br/>  "backward"：反向。<br/>  **配置示例**："fuzz_stage": "backward"。 | 否       |
-| if_preheat   | 预热功能（仅 PyTorch 场景支持），开启功能后工具可以根据每次迭代的输出调整精度算法的阈值，从而更准确地找出存在精度问题的 API，bool 类型。可取值：<br/>  true（开启）或 false（关闭），默认关闭。<br/>  **配置示例**："if_preheat": "true"。"handler_type": "fix"不支持预热。 | 否       |
-| preheat_step | 开启预热的迭代数量（仅 PyTorch 场景支持），int 类型，默认值为 15。须配置 "if_preheat": "true"。 | 否       |
-| max_sample   | 每个算子预热的采样次数的最大阈值（仅 PyTorch 场景支持），int 类型，默认值为 20。须配置 "if_preheat": "true"。 | 否       |
+<table>
+    <tr><th>参数</th><th>解释</th><th>是否必选</th></tr>
+    <tr><td>scope</td><td>自定义检测 API 列表（仅 PyTorch 场景支持），list[str] 类型，默认值为空列表，当 list 也为空列表时，表示检测所有 API。需要在 [ ] 内配置具体 API 名（在 dump 的结果中查看）。与 list 参数不能同时配置。<br/><b>配置示例</b>："scope": ["Torch.matmul.0.forward", "Tensor.pow.4.forward"]。</td><td>否</td></tr>
+    <tr><td rowspan="3">list</td><td>自定义检测 API 类型或 API 名称，list[str] 类型，默认值为空列表，表示检测所有 API（PyTorch 场景下还需 scope 也为空列表）。与 scope 参数不能同时配置。</td><td rowspan="3">否</td></tr>
+    <tr><td>PyTorch 场景：指定某一类 API，对某一类的 API 进行无标杆比对。<br/><b>配置示例</b>："list": ["relu"]。</td></tr>
+    <tr><td>MindSpore 场景：指定 API 名称，对列表中的 API 进行检测。<br/><b>配置示例</b>："list": ["mindspore.mint.div", "mindspore.ops.bmm", "mindspore.Tensor.__add__"]。</td></tr>
+    <tr><td>fuzz_device</td><td>标杆设备，str 类型。可选参数：<br/>        "npu"：无标杆，通过添加扰动因子进行比对，默认值；<br/>        "cpu"：以 CPU 为标杆，pert_mode 须配置为"to_cpu"（仅 PyTorch 场景支持）。<br/><b>配置示例</b>："fuzz_device": "npu"。</td><td>否</td></tr>
+    <tr><td>pert_mode</td><td>无标杆扰动因子，str 类型。可选参数：<br/>  "improve_precision"：对输入做升精度，默认值；<br/>        "add_noise"：对输入增加噪声；<br/>        "no_change"：不加扰动直接二次执行；<br/>        "bit_noise"：输入的末位比特翻转，MindSpore 场景不支持 BF16 类型的向量；<br/>        "change_value"：输入的张量首尾值调换；<br/>        "to_cpu"：在 CPU 等价执行（仅 PyTorch 场景支持）。<br/><b>配置示例</b>："pert_mode": "improve_precision"。</td><td>否</td></tr>
+    <tr><td>handler_type</td><td>处理类型，可选参数：<br/> "check"：进行无标杆比对检查，默认值；<br/> "fix"：将扰动后的 API 输出结果覆盖原始 API 输出结果，尝试将 Loss 曲线恢复正常，该模式下不支持预热功能与反向过程，且仅支持"improve_precision"、"to_cpu"（ PyTorch 场景）两种扰动因子。<br/> <b>配置示例</b>："handler_type": "check"。</td><td>否</td></tr>
+    <tr><td>fuzz_level</td><td>无标杆数据 dump 级别，即选择比对结果文件应输出的表头属性，当前仅支持取值为："L1"。输出结果详见 <a href="#161-无标杆比对数据存盘格式">1.6.1 无标杆比对数据存盘格式</a>。</td><td>否</td></tr>
+    <tr><td>fuzz_stage</td><td>比对过程，选择对 API 前向或反向进行无标杆比对，可选参数：<br/> "forward"：前向，默认值；<br/>  "backward"：反向。当 fuzz_stage 为 "backward" 时，handler_type 只能为 "check"。<br/>  <b>配置示例</b>："fuzz_stage": "backward"。</td><td>否</td></tr>
+    <tr><td>if_preheat</td><td>预热功能（仅 PyTorch 场景支持），bool 类型。开启功能后工具可以根据每次迭代的输出调整精度算法的阈值，从而更准确地找出存在精度问题的 API。当"handler_type": "fix"时，不支持预热。可选参数：<br/>  true（开启）或 false（关闭），默认关闭。<br/>  <b>配置示例</b>："if_preheat": "true"。</td><td>否</td></tr>
+    <tr><td>preheat_step</td><td>开启预热的迭代数量（仅 PyTorch 场景支持），int 类型，默认值为 15。须配置 "if_preheat": "true"。</td><td>否</td></tr>
+    <tr><td>max_sample</td><td>每个算子预热的采样次数的最大阈值（仅 PyTorch 场景支持），int 类型，默认值为 20。须配置 "if_preheat": "true"。</td><td>否</td></tr>
+</table>
 
 #### 1.6.1 无标杆比对数据存盘格式
 
@@ -152,7 +122,7 @@ PyTorch 与 MindSpore 动态图场景下，"level"须为"L1"；MindSpore 静态
 
 ![free_benchmark](./img/free_benchmark.png)
 
-| 字段         | 说明                                                         |
+| 字段         | 解释                                                         |
 | ------------ | --------------------- |
 | rank         | Rank ID，int 类型。                                           |
 | pert_mode    | 扰动因子的类型，string 类型。                                 |
@@ -163,3 +133,32 @@ PyTorch 与 MindSpore 动态图场景下，"level"须为"L1"；MindSpore 静态
 | dtype        | 输入的 dtype，string 类型。                                    |
 | shape        | 输入的 shape，tuple 类型。                                     |
 | output_index | 如果输出为列表或元组，其中一个元素检测不一致，则会有该元素的 index，否则为空，int 类型。 |
+
+
+### 1.7 task 配置为 grad_probe
+
+   **参数说明**
+
+   | 参数                       | 说明                          | 输入类型                     | 是否必选 |
+   |--------------------------------|-----------------------------------|-----------------|----------|
+   | task            | 填为"grad_probe"。 |  str | 是 |
+   | dump_path            | 输出目录。如果不存在就会创建一个新目录。 |  str | 是 |
+   | rank                   | rank id列表，在多卡场景下，表示需要导出梯度数据的进程的rank id。列表为空就表示导出所有rank的数据。默认为空。采集特定 rank 时，须指定为训练脚本中存在的 rank_id，可逐个配置，也可以指定范围。<br/>  **配置示例**："rank": [0, 1 , 2, "4-6"]。（MindSpore静态图模式下，当前暂不支持指定rank功能） | list[Union[int, str]] | 否       |
+   | step                   | step列表，表示需要导出数据的step列表。列表为空就表示导出所有step的数据。默认为空。采集特定 step 时，须指定为训练脚本中存在的 step，可逐个配置，也可以指定范围。<br/>  **配置示例**："step": [0, 1 , 2, "4-6"]。（MindSpore静态图模式下，当前暂不支持指定step功能） | list[Union[int, str]] | 否 |
+   | grad_level                  | 输出级别。决定导出数据的详细程度，级别越大导出数据越详细。可取值：L0, L1, L2。默认L1。|str  | 否     |
+   | param_list             | 权重名称列表，表示需要监控的权重。列表为空就表示监控所有权重。默认为空。 | List[str] | 否       |
+   | bounds                 | 区间列表，用来划分区间以统计数值的分布。需要保证由数据小到大排列，并且列表中的元素需要在int64取值范围内。可以使用默认值[-1, 0, 1]。 | List[float, int] | 否  |
+
+   
+   **不同级别的level的导出数据**
+
+
+   | 级别 | 特征数据表头                                                 | 是否有方向数据 |
+   | ---- | ------------------------------------------------------------ | -------------- |
+   | L0   | ("param_name", "MD5", "max", "min", "norm", "shape")         | 否             |
+   | L1   | ("param_name", "max", "min", "norm", "shape")         | 是             |
+   | L2   | ("param_name", *intervals, "=0", "max", "min", "norm", "shape") | 是             |
+
+   intervals就是根据值分布bounds划分出的区间。
+   MindSpore静态图模式下，L0级别中暂不支持"MD5"
+

msprobe/docs/03.config_examples.md

@@ -13,9 +13,6 @@
     "rank": [],
     "step": [],
     "level": "L1",
-    "seed": 1234,
-    "is_deterministic": false,
-    "enable_dataloader": false,
 
     "statistics": {
         "scope": [], 
@@ -35,15 +32,11 @@
     "rank": [],
     "step": [],
     "level": "L1",
-    "seed": 1234,
-    "is_deterministic": false,
-    "enable_dataloader": false,
 
     "tensor": {
         "scope": [],
         "list":[],
-        "data_mode": ["all"],
-        "backward_input": ""
+        "data_mode": ["all"]
     }
 }
 ```
@@ -57,9 +50,6 @@
     "rank": [],
     "step": [],
     "level": "L1",
-    "seed": 1234,
-    "is_deterministic": false,
-    "enable_dataloader": false,
 
     "run_ut": {
         "white_list": [],
@@ -78,9 +68,6 @@
     "rank": [],
     "step": [],
     "level": "L1",
-    "seed": 1234,
-    "is_deterministic": false,
-    "enable_dataloader": false,
 
     "overflow_check": {
         "overflow_nums": 1
@@ -97,9 +84,6 @@
     "rank": [],
     "step": [],
     "level": "L1",
-    "seed": 1234,
-    "is_deterministic": false,
-    "enable_dataloader": false,
 
     "free_benchmark": {
         "scope": [], 
@@ -116,7 +100,7 @@
 }
 ```
 
-## 2 MindSpore 静态图场景 
+## 2 MindSpore 静态图场景
 
 ### 2.1 task 配置为 statistics
 
@@ -148,8 +132,7 @@
 
     "tensor": {
         "list":[],
-        "data_mode": ["all"],
-        "backward_input": ""
+        "data_mode": ["all"]
     }
 }
 ```

msprobe/docs/04.kernel_dump_PyTorch.md

@@ -0,0 +1,73 @@
+# PyTorch 场景的 kernel dump 说明
+
+当使用 msprobe 数据采集功能时，level 配置为 "L2" 表示采集 kernel 层级的算子数据，仅支持昇腾 NPU 平台。 
+
+本文主要介绍 kernel dump 的配置示例和采集结果介绍， msprobe 数据采集功能的详细使用参考 《[PyTorch 场景的精度数据采集](./05.data_dump_PyTorch.md)》。
+
+## 1 kernel dump 配置示例
+
+使用 kernel dump 时，list 必须要填一个 API 名称，kernel dump 目前每个 step 只支持采集一个 API 的数据。
+API 名称填写参考 L1 dump 结果文件 dump.json 中的API名称，命名格式为：`{api_type}.{api_name}.{API调用次数}.{forward/backward}`。
+
+```json
+{
+    "task": "tensor",
+    "dump_path": "/home/data_dump",
+    "level": "L2",
+    "rank": [],
+    "step": [],
+    "tensor": {
+        "scope": [],
+        "list": ["Functional.linear.0.backward"]
+    }
+}
+```
+
+## 2 结果文件介绍
+
+### 2.1 采集结果说明
+    
+如果 API kernel 级数据采集成功，会打印以下信息：
+
+```bash
+The kernel data of {api_name} is dumped successfully.
+```
+
+注意：如果打印该信息后，没有数据生成，参考**常见问题3.1**进行排查。
+
+如果 kernel dump 遇到不支持的 API， 会打印以下信息：
+
+```bash
+The kernel dump does not support the {api_name} API.
+```
+
+其中 {api_name} 是对应溢出的 API 名称。
+
+### 2.2 输出文件说明
+kernel dump 采集成功后，会在指定的 dump_path 目录下生成如下文件：
+
+```
+├── /home/data_dump/
+│   ├── step0
+│   │   ├── 20241201103000    # 日期时间格式，表示2024-12-01 10:30:00
+│   │   │   ├── 0             # 表示 device id
+│   │   │   │   ├──{op_type}.{op_name}.{task_id}.{stream_id}.{timestamp}    # kernel 层算子数据
+│   │   │  ...
+│   │   ├── kernel_config_{device_id}.json    # kernel dump 在接口调用过程中生成的中间文件，一般情况下无需关注
+│   │  ...     
+│   ├── step1
+│  ...
+```
+成功采集到数据后，可以使用 msprobe 工具提供的《[PyTorch 场景的数据解析](./14.data_parse_PyTorch.md)》功能分析数据。
+
+## 3 常见问题
+
+#### 3.1 采集结果文件为空，有可能是什么原因？
+
+1. 首先需要确认工具使用方式、配置文件内容、list 填写的 API 名称格式是否都正确无误。
+
+2. 其次需要确认 API 是否运行在昇腾 NPU 上，如果是运行在其他设备上则不会存在 kernel 级数据。
+
+3. 如果排除上述两点仍然没有数据，您可以使用《[Ascend Extension for PyTorch 插件](https://gitee.com/ascend/pytorch)》提供的
+torch_npu.npu 接口进行 kernel 层数据采集，工具的 kernel dump 也是基于其中的init_dump、set_dump和finalize_dump三个子接口实现的。
+torch_npu.npu 接口详细描述见《[torch_npu.npu API 概述](https://www.hiascend.com/document/detail/zh/Pytorch/60RC3/apiref/apilist/ptaoplist_000192.html)》。