mindstudio-probe 1.3.0__py3-none-any.whl → 8.1.1__py3-none-any.whl

msprobe/docs/05.data_dump_PyTorch.md

@@ -2,7 +2,7 @@
 
 msprobe 工具主要通过在训练脚本内添加 dump 接口、启动训练的方式采集精度数据。
 
-dump的'tensor'模式采集数据量大小，可以参考[数据量基线](./26.data_dump_PyTorch_baseline.md)。
+dump "statistics"模式的性能膨胀大小"与"tensor"模式采集的数据量大小，可以参考[dump基线](./26.data_dump_PyTorch_baseline.md)。
 
 本工具提供固定的 API 支持列表，若需要删除或增加 dump 的 API，可以在 msprobe/pytorch/hook_module/support_wrap_ops.yaml 文件内手动修改，如下示例：
 
@@ -15,6 +15,52 @@ functional:  # functional为算子类别，找到对应的类别，在该类别
 
 删除API的场景：部分模型代码逻辑会存在API原生类型校验，工具执行dump操作时，对模型的API封装可能与模型的原生API类型不一致，此时可能引发校验失败，详见《[FAQ](FAQ.md)》中“异常情况”的第10和11条。
 
+## 快速上手
+
+这个示例定义了一个 nn.Module 类型的简单网络，使用原型函数 PrecisionDebugger 进行数据采集。
+
+```python
+# 根据需要import包
+import torch
+import torch.nn as nn
+import torch.nn.functional as F
+
+# 导入工具的数据采集接口
+from msprobe.pytorch import PrecisionDebugger, seed_all
+
+# 在模型训练开始前固定随机性
+seed_all()
+
+# 在模型训练开始前实例化PrecisionDebugger
+debugger = PrecisionDebugger()
+
+# 定义网络
+class ModuleOP(nn.Module):
+    def __init__(self) -> None:
+        super().__init__()
+        self.linear_1 = nn.Linear(in_features=8, out_features=4)
+        self.linear_2 = nn.Linear(in_features=4, out_features=2)
+
+    def forward(self, x):
+        x1 = self.linear_1(x)
+        x2 = self.linear_2(x1)
+        r1 = F.relu(x2)
+        return r1
+
+if __name__ == "__main__":
+    module = ModuleOP()
+    
+    # 开启数据 dump
+    debugger.start(model=module)
+    x = torch.randn(10, 8)
+    out = module(x)
+    loss = out.sum()
+    loss.backward()
+
+    # 关闭数据 dump
+    debugger.stop()
+```
+
 ## 1 接口介绍
 
 ### 1.1 PrecisionDebugger
@@ -30,9 +76,9 @@ PrecisionDebugger(config_path=None, task=None, dump_path=None, level=None, model
 1. config_path：指定 dump 配置文件路径；
 2. model：指定需要采集 Module 级数据的模型，支持传入 torch.nn.Module 或 list[torch.nn.Module] 类型，默认未配置。
 level 配置为"L0"或"mix"时，必须在该接口或 **start** 接口中配置该参数。该参数在将来会从该接口移除，建议在 **start** 接口中配置该参数。
-3. 其他参数均在 [config.json](../config.json) 文件中可配，详细配置可见 [config.json 介绍](./02.config_introduction.md)。
+3. 其他参数均在 config.json 文件中可配，详细配置可见 [config.json 介绍](./02.config_introduction.md)。
 
-此接口的参数均不是必要，且优先级高于 [config.json](../config.json) 文件中的配置，但可配置的参数相比 config.json 较少。
+此接口的参数均不是必要（均不配置的情况下默认采集所有 rank 和 step 的 L1 级别的统计数据），且优先级高于 config.json 文件中的配置，但可配置的参数相比 config.json 较少。
 
 注：此接口的初始化需与采集目标在同一个进程中，否则将无法采集目标数据。
 
@@ -43,12 +89,15 @@ level 配置为"L0"或"mix"时，必须在该接口或 **start** 接口中配置
 **原型**：
 
 ```Python
-debugger.start(model=None)
+debugger.start(model=None, token_range=None)
 ```
 
 1. model：指定需要采集 Module 级数据的模型，支持传入 torch.nn.Module、list[torch.nn.Module]或Tuple[torch.nn.Module] 类型，默认未配置。
-level 配置为"L0"或"mix"时，必须在该接口或 **PrecisionDebugger** 接口中配置该参数。
+level 配置为"L0"|"mix"或token_range不为None时，必须在该接口或 **PrecisionDebugger** 接口中配置该参数。
 本接口中的 model 比 PrecisionDebugger 中 model 参数优先级更高，会覆盖 PrecisionDebugger 中的 model 参数。
+<br>对于复杂模型，如果仅需要监控一部分(如model.A，model.A extends torch.nn.Module)，传入需要监控的部分(如model.A)即可。  
+注意：传入的当前层不会被dump，工具只会dump传入层的子层级。如传入了model.A，A本身不会被dump，而是会dump A.x, A.x.xx等。
+2. token_range：指定推理模型采集时的token循环始末范围，支持传入[int, int]类型，代表[start, end]，范围包含边界，默认未配置。
 
 ### 1.3 stop
 
@@ -203,55 +252,47 @@ debugger.set_init_step(step)
 
 1.step: 指定的起始step数。
 
+### 1.11 register_custom_api
 
-## 2 示例代码
+**功能说明**：注册用户自定义的api到工具用于 L1 dump 。
 
-### 2.1 快速上手
+**原型**：
 
-这个示例定义了一个 nn.Module 类型的简单网络，在进行数据采集时使用原型函数 PrecisionDebugger 传入 config_path 参数和 model 参数。
+```Python
+debugger.register_custom_api(module, api_name, api_prefix)
+```
+**参数说明**:
 
-```python
-# 根据需要import包
-import torch
-import torch.nn as nn
-import torch.nn.functional as F
+以 torch.matmul api 为例
 
-# 导入工具的数据采集接口
-from msprobe.pytorch import PrecisionDebugger, seed_all
+1.module: api 所属的包，即传入 torch。
 
-# 在模型训练开始前固定随机性
-seed_all()
-# 在模型训练开始前实例化PrecisionDebugger
-debugger = PrecisionDebugger(config_path='./config.json')
+2.api_name: api 名，string类型，即传入 "matmul"。
 
-# 定义网络
-class ModuleOP(nn.Module):
-    def __init__(self) -> None:
-        super().__init__()
-        self.linear_1 = nn.Linear(in_features=8, out_features=4)
-        self.linear_2 = nn.Linear(in_features=4, out_features=2)
+3.api_prefix: [dump.json](./27.dump_json_instruction.md) 中 api 名的前缀，可选，默认为包名的字符串格式, 即 "torch"。
 
-    def forward(self, x):
-        x1 = self.linear_1(x)
-        x2 = self.linear_2(x1)
-        r1 = F.relu(x2)
-        return r1
+### 1.12 restore_custom_api
 
-if __name__ == "__main__":
-    module = ModuleOP()
-    # 开启数据 dump
-    debugger.start(model=module)
+**功能说明**：恢复用户原有的自定义的api，取消 dump 。
 
-    x = torch.randn(10, 8)
-    out = module(x)
-    loss = out.sum()
-    loss.backward()
+**原型**：
 
-    # 关闭数据 dump
-    debugger.stop()
+```Python
+debugger.restore_custom_api(module, api_name)
 ```
+**参数说明**:
+
+以 torch.matmul api 为例
+
+1.module: api 所属的包，即传入 torch。
+
+2.api_name: api 名，string类型，即传入 "matmul"。
+
+
+## 2 示例代码
+
 
-### 2.2 采集完整的前反向数据
+### 2.1 采集完整的前反向数据
 
 ```Python
 from msprobe.pytorch import PrecisionDebugger, seed_all
@@ -272,7 +313,7 @@ for data, label in data_loader:
     debugger.step()  # 结束一个step的dump
 ```
 
-### 2.3 采集指定代码块的前反向数据
+### 2.2 采集指定代码块的前反向数据
 
 ```Python
 from msprobe.pytorch import PrecisionDebugger, seed_all
@@ -296,7 +337,7 @@ for data, label in data_loader:
     debugger.step()  # 结束一个step的dump
 ```
 
-### 2.4 采集函数模块化数据
+### 2.3 采集函数模块化数据
 
 ```Python
 # 根据需要import包
@@ -338,7 +379,7 @@ if __name__ == "__main__":
     debugger.stop()
 ```
 
-### 2.5 跨文件采集数据
+### 2.4 跨文件采集数据
 为了确保所有API都被工具封装，PrecisionDebugger的实例化通常放在训练工程的入口位置，但有的时候，模型定义会在另一个文件中。 假设有两个文件，train.py（为训练工程入口）module.py（为模型定义文件），为了采集module.py中定义的ModuleOP模块中某些子模块或API的前反向数据，需要在train.py和module.py文件中分别导入PrecisionDebugger并进行如下配置。
 
 train.py文件：
@@ -389,6 +430,29 @@ class ModuleOP(nn.Module):
 
 ```
 
+### 2.5 推理模型采集指定token_range
+
+```Python
+from vllm import LLM, SamplingParams
+from msprobe.pytorch import PrecisionDebugger, seed_all
+# 在模型训练开始前固定随机性
+seed_all()
+# 请勿将PrecisionDebugger的初始化流程插入到循环代码中
+debugger = PrecisionDebugger(config_path="./config.json", dump_path="./dump_path")
+# 模型定义及初始化等操作
+prompts = ["Hello, my name is"]
+sampling_params = SamplingParams(temprature=0.8, top_p=0.95)
+llm = LLM(model='...')
+model = llm.llm_engine.model_executor.driver_worker.worker.model_runner.get_model()
+# 开启数据dump, 指定采集推理模型逐字符循环推理中的第1~3次
+debugger.start(model=model, token_range=[1,3])  
+# 推理模型生成的逻辑
+output = llm.generate(prompts, sampling_params=sampling_params)
+# 关闭数据dump并落盘
+debugger.stop()
+debugger.step()
+```
+
 ## 3 dump 结果文件介绍
 
 训练结束后，工具将 dump 的数据保存在 dump_path 参数指定的目录下。目录结构示例如下：
@@ -402,17 +466,19 @@ class ModuleOP(nn.Module):
 |   |   |   |    ├── Functional.linear.5.backward.output.pt    # 命名格式为{api_type}.{api_name}.{API调用次数}.{forward/backward}.{input/output}.{参数序号}, 其中，“参数序号”表示该API的第n个输入或输出，例如1，则为第一个参数，若该参数为list格式，则根据list继续排序，例如1.1，表示该API的第1个参数的第1个元素。
 |   |   |   |    ...
 |   |   |   |    ├── Module.conv1.Conv2d.forward.0.input.0.pt          # 命名格式为{Module}.{module_name}.{class_name}.{forward/backward}.{调用次数}.{input/output}.{参数序号}, 其中，“参数序号”表示该Module的第n个参数，例如1，则为第一个参数，若该参数为list格式，则根据list继续排序，例如1.1，表示该Module的第1个参数的第1个元素。
-|   |   |   |    ├── Module.conv1.Conv2D.forward.0.parameters.bias.pt  # 模块参数数据：命名格式为{Module}.{module_name}.{class_name}.forward.{调用次数}.parameters.{parameter_name}。
-|   |   |   |    └── Module.conv1.Conv2D.parameters_grad.weight.pt     # 模块参数梯度数据：命名格式为{Module}.{module_name}.{class_name}.parameters_grad.{parameter_name}。因为同一模块的参数使用同一梯度进行更新，所以参数梯度文件名不包含调用次数。
+|   |   |   |    ├── Module.conv1.Conv2d.forward.0.parameters.bias.pt  # 模块参数数据：命名格式为{Module}.{module_name}.{class_name}.forward.{调用次数}.parameters.{parameter_name}。
+|   |   |   |    └── Module.conv1.Conv2d.parameters_grad.weight.pt     # 模块参数梯度数据：命名格式为{Module}.{module_name}.{class_name}.parameters_grad.{parameter_name}。因为同一模块的参数使用同一梯度进行更新，所以参数梯度文件名不包含调用次数。
 |   |   |   |                                                          # 当dump时传入的model参数为List[torch.nn.Module]或Tuple[torch.nn.Module]时，模块级数据的命名中包含该模块在列表中的索引index，命名格式为{Module}.{index}.*，*表示以上三种模块级数据的命名格式，例如：Module.0.conv1.Conv2d.forward.0.input.0.pt。
 │   |   |   ├── dump.json
 │   |   |   ├── stack.json
+│   |   |   ├── dump_error_info.log
 │   |   |   └── construct.json
 │   |   ├── rank1
 |   |   |   ├── dump_tensor_data
 |   |   |   |   └── ...
 │   |   |   ├── dump.json
 │   |   |   ├── stack.json
+│   |   |   ├── dump_error_info.log
 |   |   |   └── construct.json
 │   |   ├── ...
 │   |   |
@@ -424,6 +490,7 @@ class ModuleOP(nn.Module):
 * `rank`：设备 ID，每张卡的数据保存在对应的 `rank{ID}` 目录下。非分布式场景下没有 rank ID，目录名称为 rank。
 * `dump_tensor_data`：保存采集到的张量数据。
 * `dump.json`： 保存API或Module前反向数据的统计量信息。包含dump数据的API名称或Module名称，各数据的dtype、 shape、max、min、mean、L2norm（L2范数，平方根）统计信息以及当配置summary_mode="md5"时的CRC-32数据。具体介绍可参考[dump.json文件说明](./27.dump_json_instruction.md#1-PyTorch场景下的dump.json文件)。
+* `dump_error_info.log`: 仅在dump工具报错时拥有此记录日志，用于记录dump错误日志。
 * `stack.json`：API/Module的调用栈信息。
 * `construct.json`：分层分级结构，level为L1时，construct.json内容为空。
 
@@ -434,12 +501,14 @@ dump 过程中，pt 文件在对应算子或者模块被执行后就会落盘，
 
 pt 文件保存的前缀和 PyTorch 对应关系如下：
 
-| 前缀        | Torch模块           |
-| ----------- | ------------------- |
+| 前缀          | Torch模块             |
+|-------------|---------------------|
 | Tensor      | torch.Tensor        |
 | Torch       | torch               |
 | Functional  | torch.nn.functional |
-| NPU         | NPU 亲和算子         |
+| NPU         | NPU 亲和算子            |
 | VF          | torch._VF           |
 | Aten        | torch.ops.aten      |
 | Distributed | torch.distributed   |
+| MindSpeed   | mindspeed.ops       |
+

msprobe/docs/06.data_dump_MindSpore.md

@@ -26,18 +26,20 @@
 
 msprobe 工具通过在训练脚本中添加 `PrecisionDebugger` 接口并启动训练的方式，采集模型在运行过程中的精度数据。该工具支持对MindSpore的静态图和动态图场景进行不同Level等级的精度数据采集。
 
-dump 的"tensor"模式采集数据量大小，可以参考[数据量基线](data_dump_MindSpore/data_dump_MindSpore_baseline.md)。
+dump "statistics"模式的性能膨胀大小"与"tensor"模式采集的数据量大小，可以参考[dump基线](data_dump_MindSpore/data_dump_MindSpore_baseline.md)。
 
 ## 5. 场景介绍
 
 ### 5.1 静态图场景
-在静态图场景下，msprobe 仅支持 **L2 Level**  的数据采集，且当 MindSpore 版本高于 2.5.0 时，必须使用编包时添加了`--include-mod=adump`选项的 mindstudio-probe whl 包进行 msprobe 工具安装。
+在静态图场景下，msprobe 支持 **L0 Level** 和 **L2 Level** 的数据采集。且当 MindSpore 版本高于 2.5.0 时，若需采集 **L2 Level** 数据，必须使用编包时添加了`--include-mod=adump`选项的 mindstudio-probe whl 包进行 msprobe 工具安装。
+- **L0 Level（Cell 级）** ：采集 `Cell` 对象的数据，适用于需要分析特定网络模块的情况。仅支持 2.7.0 及以上版本的 MindSpore 框架。
+
 - **L2 Level（Kernel 级）** ：采集底层算子的输入输出数据，适用于深入分析算子级别的精度问题。
 
 采集方式请参见[示例代码 > 静态图场景](#71-静态图场景)。详细介绍请参见[《config.json 配置文件介绍》](./02.config_introduction.md#11-通用配置)中的“level 参数”和[《config.json 配置示例》](./03.config_examples.md#2-mindspore-静态图场景) 中的“MindSpore 静态图场景”。
 
 ### 5.2 动态图场景
-在动态图场景下，msprobe 支持 **L0** 、**L1** 、**mix** 、**L2 Level**、 **debug**  的数据采集，具体分为以下几种情况：
+在动态图场景下，msprobe 支持 **L0** 、**L1** 、**mix** 、**L2**、 **debug**  的数据采集，具体分为以下几种情况：
 - **使用高阶 API（如 `Model 高阶API`）** ：
   - 需要使用 `MsprobeStep` 回调类来控制数据采集的启停，适用于 **L0** 、**L1** 、**mix** 、**L2** 数据采集。
 
@@ -46,7 +48,7 @@ dump 的"tensor"模式采集数据量大小，可以参考[数据量基线](data
 
 采集方式请参见[示例代码 > 动态图场景](#72-动态图场景)。
 
-> **注意** ：动态图模式下，使用 `PSJit` 或 `PIJit` 装饰的部分实际以静态图模式执行，此时的 **Kernel 级（L2 Level）**  数据采集方式与静态图场景相同。
+> **注意** ：动态图模式下，使用 `mindspore.jit` 装饰的部分实际以静态图模式执行，此时的 **Kernel 级（L2 Level）**  数据采集方式与静态图场景相同。
 - **L0 Level（Cell 级）** ：采集 `Cell` 对象的数据，适用于需要分析特定网络模块的情况。
 
 - **L1 Level（API 级）** ：采集 MindSpore API 的输入输出数据，适用于定位 API 层面的精度问题。
@@ -56,7 +58,7 @@ dump 的"tensor"模式采集数据量大小，可以参考[数据量基线](data
 - **debug level （单点保存）**：单点保存网络中变量的正反向数据，适用于用户熟悉网络结构的场景。
 
 
-详细介绍请参见[《config.json 配置文件介绍》](./02.config_introduction.md#11-通用配置)中的“level 参数”和[《config.json 配置示例》](./03.config_examples.md#3-mindspore-动态图场景) 中的“MindSpore 动态图场景”。
+详细介绍请参见[《config.json 配置文件介绍》](./02.config_introduction.md#11-通用配置)中的“level 参数”。
 
 
 ## 6 接口介绍
@@ -85,12 +87,15 @@ PrecisionDebugger(config_path=None, task=None, dump_path=None, level=None, step=
 **原型**：
 
 ```Python
-start(model=None)
+start(model=None, token_range=None)
 ```
 
 **参数说明**:
 
-1. model：指定需要采集数据的实例化模型，支持传入mindspore.nn.Cell、List[mindspore.nn.Cell]或Tuple[mindspore.nn.Cell] 类型, 默认未配置。Cell级别（"L0" level）dump 与 "mix" level dump 时，必须传入 model 才可以采集 model 内的所有Cell 对象数据。API级别（"L1" level）dump 时，传入 model 可以采集 model 内包含 primitive op 对象在内的所有 API 数据，若不传入 model 参数，则只采集非 primitive op 的 API 数据。
+1. model：指定需要采集数据的实例化模型，支持传入mindspore.nn.Cell、List[mindspore.nn.Cell]或Tuple[mindspore.nn.Cell] 类型，默认未配置。Cell级别（"L0" level）dump 与 "mix" level dump 时，必须传入 model 才可以采集 model 内的所有Cell 对象数据。API级别（"L1" level）dump 时，传入 model 可以采集 model 内包含 primitive op 对象在内的所有 API 数据，若不传入 model 参数，则只采集非 primitive op 的 API 数据。token_range不为None时，必须传入model参数。
+<br>对于复杂模型，如果仅需要监控一部分(如model.A，model.A extends mindspore.nn.Cell)，传入需要监控的部分(如model.A)即可。  
+注意：传入的当前层不会被dump，工具只会dump传入层的子层级。如传入了model.A，A本身不会被dump，而是会dump A.x, A.x.xx等。
+2. token_range：指定推理模型采集时的token循环始末范围，支持传入[int, int]类型，代表[start, end]，范围包含边界，默认未配置。
 
 #### 6.1.2 stop
 
@@ -110,7 +115,7 @@ stop()
 
 **功能说明**：结束一个 step 的数据采集，完成所有数据落盘并更新 dump 参数。在一个 step 结束的位置添加，且必须在 **stop** 函数之后的位置调用。
 该函数需要配合 **start** 和 **stop** 函数使用，尽量添加在反向计算代码之后，否则可能会导致反向数据丢失。
-**仅未使用 Model 高阶 API 的动态图场景支持。**
+**仅未使用 Model 高阶 API 的动态图和静态图场景支持。**
 
 **原型**：
 
@@ -151,7 +156,7 @@ save(variable, name, save_backward=True)
 
 #### 6.1.6 set_init_step
 
-**功能说明**：设置起始step数，step数默认从0开始计数，使用该接口后step从指定值开始计数。该函数需要写在训练迭代的循环开始前，不能写在循环内。。
+**功能说明**：设置起始step数，step数默认从0开始计数，使用该接口后step从指定值开始计数。该函数需要写在训练迭代的循环开始前，不能写在循环内。
 
 **原型**：
 
@@ -164,9 +169,46 @@ set_init_step(step)
 1.step: 指定的起始step数。
 
 
+#### 6.1.7 register_custom_api
+
+**功能说明**：注册用户自定义的api到工具，用于 L1 dump 。
+
+**原型**：
+
+```Python
+debugger.register_custom_api(module, api_name, api_prefix)
+```
+**参数说明**:
+
+以 torch.matmul api 为例
+
+1.module: api 所属的包，即传入 torch。
+
+2.api_name: api 名，string类型，即传入 "matmul"。
+
+3.api_prefix: [dump.json](./27.dump_json_instruction.md) 中 api 名的前缀，可选，默认为包名的字符串格式， 即 "torch"。
+
+#### 6.1.8 restore_custom_api
+
+**功能说明**：恢复用户原有的自定义的api，取消 dump 。
+
+**原型**：
+
+```Python
+debugger.restore_custom_api(module, api_name)
+```
+**参数说明**:
+
+以 torch.matmul api 为例
+
+1.module: api 所属的包，即传入 torch。
+
+2.api_name: api 名，string类型，即传入 "matmul"。
+
+
 ### 6.2 msprobe.mindspore.MsprobeStep
 
-**功能说明**：MindSpore Callback类，自动在每个step开始时调用start()接口，在每个step结束时调用stop()、step()接口。实现使用 Model 高阶 API 的动态图场景下 L0、L1、mix 级别的精度数据采集控制，控制粒度为单个 **Step** ，而 PrecisionDebugger.start, PrecisionDebugger.stop 接口的控制粒度任意训练代码段。
+**功能说明**：MindSpore Callback类，自动在每个step开始时调用start()接口，在每个step结束时调用stop()、step()接口。实现使用 Model 高阶 API 的动态图场景下 L0、L1、mix 级别，和静态图场景下 L0级别的精度数据采集控制，控制粒度为单个 **Step** ，而 PrecisionDebugger.start, PrecisionDebugger.stop 接口的控制粒度为任意训练代码段。
 
 **原型**：
 
@@ -209,6 +251,56 @@ seed_all(seed=1234, mode=False, rm_dropout=True)
 
 ### 7.1 静态图场景
 
+#### 7.1.1 L0 级别
+
+**说明**: 静态图 L0 级别的Dump功能是基于mindspore.ops.TensorDump算子实现。在Ascend平台上的Graph模式下，可以通过设置环境变量 [MS_DUMP_SLICE_SIZE 和 MS_DUMP_WAIT_TIME](https://www.mindspore.cn/docs/zh-CN/r2.5.0/api_python/env_var_list.html) 解决在输出大Tesnor或输出Tensor比较密集场景下算子执行失败的问题。
+
+##### 7.1.1.1 未使用 Model 高阶 API
+
+
+```python
+import mindspore as ms
+ms.set_context(mode=ms.GRAPH_MODE, device_target="Ascend")
+
+from msprobe.mindspore import PrecisionDebugger
+debugger = PrecisionDebugger(config_path="./config.json")
+
+# 模型、损失函数的定义以及初始化等操作
+# ...
+model = Network()
+# 数据集迭代的地方往往是模型开始训练的地方
+for data, label in data_loader:
+    debugger.start(model) # 进行 L0 级别下Cell 对象的数据采集时调用
+    # 如下是模型每个 step 执行的逻辑
+    grad_net = ms.grad(model)(data)
+    # ...
+    debugger.step()         # 更新迭代数
+```
+
+##### 7.1.1.2 使用 Model 高阶 API
+
+
+```python
+import mindspore as ms
+from mindspore.train import Model
+ms.set_context(mode=ms.GRAPH_MODE, device_target="Ascend")
+
+from msprobe.mindspore import PrecisionDebugger
+from msprobe.mindspore.common.utils import MsprobeStep
+debugger = PrecisionDebugger(config_path="./config.json")
+
+# 模型、损失函数的定义以及初始化等操作
+# ...
+
+model = Network()
+# 进行 L0 级别下 Cell 对象的数据采集时调用
+debugger.start(model)
+trainer = Model(model, loss_fn=loss_fn, optimizer=optimizer, metrics={'accuracy'})
+trainer.train(1, train_dataset, callbacks=[MsprobeStep(debugger)])
+```
+
+#### 7.1.2 L2 级别
+
 ```python
 import mindspore as ms
 ms.set_context(mode=ms.GRAPH_MODE, device_target="Ascend")
@@ -219,7 +311,8 @@ debugger.start()
 # 请勿将以上初始化流程置于模型实例化或 mindspore.communication.init 调用后
 # 模型定义和训练代码
 # ...
-
+debugger.stop()
+debugger.step()
 ```
 
 ### 7.2 动态图场景
@@ -318,11 +411,38 @@ trainer = Model(model, loss_fn=loss_fn, optimizer=optimizer, metrics={'accuracy'
 trainer.train(1, train_dataset)
 ```
 
+
+#### 7.2.3 推理模型采集指定token_range
+需要配合mindtorch套件改造原推理代码，套件包装后使用方式与torch一致，唯一区别为import的是msprobe.mindspore下的PrecisionDebugger。
+
+```Python
+from vllm import LLM, SamplingParams
+from msprobe.mindspore import PrecisionDebugger, seed_all
+# 在模型训练开始前固定随机性
+seed_all()
+# 请勿将PrecisionDebugger的初始化流程插入到循环代码中
+debugger = PrecisionDebugger(config_path="./config.json", dump_path="./dump_path")
+# 模型定义及初始化等操作
+prompts = ["Hello, my name is"]
+sampling_params = SamplingParams(temprature=0.8, top_p=0.95)
+llm = LLM(model='...')
+model = llm.llm_engine.model_executor.driver_worker.worker.model_runner.get_model()
+# 开启数据dump, 指定采集推理模型逐字符循环推理中的第1~3次
+debugger.start(model=model, token_range=[1,3])  
+# 推理模型生成的逻辑
+output = llm.generate(prompts, sampling_params=sampling_params)
+# 关闭数据dump并落盘
+debugger.stop()
+debugger.step()
+```
+
 ## 8. dump 结果文件介绍
 
 ### 8.1 静态图场景
 
-训练结束后，数据将保存在 `dump_path` 指定的目录下。
+训练结束后，数据将保存在 `dump_path` 指定的目录下。<br/>
+L0 级别 dump 的目录结构与动态图场景下目录结构一致。<br/>
+L2 级别 dump 的目录结构如下所示：
 
 若jit_level=O2，MindSpore 版本不低于 2.5.0，且使用mindstudio-probe发布包或源码编包时添加了`--include-mod=adump`选项，目录结构示例如下：
 ```
@@ -369,19 +489,21 @@ dump 结果目录结构示例如下：
 |   |   |   |    ├── Tensor.__add__.0.forward.output.0.npy
 |   |   |   |    ...
 |   |   |   |    ├── Jit.AlexNet.0.forward.input.0.npy
-|   |   |   |    ├── Primitive.conv2d.Conv2D.0.forward.input.0.npy
-|   |   |   |    ├── Cell.conv1.Conv2D.forward.0.parameters.weight.npy # 模块参数数据：命名格式为{Cell}.{cell_name}.{class_name}.forward.{调用次数}.parameters.{parameter_name}。
-|   |   |   |    ├── Cell.conv1.Conv2D.parameters_grad.weight.npy      # 模块参数梯度数据：命名格式为{Cell}.{cell_name}.{class_name}.parameters_grad.{parameter_name}。因为同一模块的参数使用同一梯度进行更新，所以参数梯度文件名不包含调用次数。
+|   |   |   |    ├── Primitive.conv2d.Conv2d.0.forward.input.0.npy
+|   |   |   |    ├── Cell.conv1.Conv2d.forward.0.parameters.weight.npy # 模块参数数据：命名格式为{Cell}.{cell_name}.{class_name}.forward.{调用次数}.parameters.{parameter_name}。
+|   |   |   |    ├── Cell.conv1.Conv2d.parameters_grad.weight.npy      # 模块参数梯度数据：命名格式为{Cell}.{cell_name}.{class_name}.parameters_grad.{parameter_name}。因为同一模块的参数使用同一梯度进行更新，所以参数梯度文件名不包含调用次数。
 |   |   |   |    └── Cell.relu.ReLU.forward.0.input.0.npy              # 命名格式为{Cell}.{cell_name}.{class_name}.{forward/backward}.{调用次数}.{input/output}.{参数序号}, 其中，“参数序号”表示该Cell的第n个参数，例如1，则为第一个参数，若该参数为list格式，则根据list继续排序，例如1.1，表示该Cell的第1个参数的第1个元素。
 |   |   |   |                                                          # 当dump时传入的model参数为List[mindspore.nn.Cell]或Tuple[mindspore.nn.Cell]时，模块级数据的命名中包含该模块在列表中的索引index，命名格式为{Cell}.{index}.*，*表示以上三种模块级数据的命名格式，例如：Cell.0.relu.ReLU.forward.0.input.0.npy。
 │   |   |   ├── dump.json
 │   |   |   ├── stack.json
+│   |   |   ├── dump_error_info.log
 │   |   |   └── construct.json
 │   |   ├── rank1
 |   |   |   ├── dump_tensor_data
 |   |   |   |   └── ...
 │   |   |   ├── dump.json
 │   |   |   ├── stack.json
+│   |   |   ├── dump_error_info.log
 |   |   |   └── construct.json
 │   |   ├── ...
 │   |   |
@@ -393,17 +515,42 @@ dump 结果目录结构示例如下：
 
 * `rank`：设备 ID，每张卡的数据保存在对应的 `rank{ID}` 目录下。非分布式场景下没有 rank ID，目录名称为 rank。
 * `dump_tensor_data`：保存采集到的张量数据。
-* `dump.json`： 保存API或Cell前反向数据的统计量信息。包含dump数据的API名称或Cell名称，各数据的dtype、 shape、max、min、mean、L2norm（L2范数，平方根）统计信息以及当配置summary_mode="md5"时的CRC-32数据。具体介绍可参考[dump.json文件说明](./27.dump_json_instruction.md#2-MindSpore场景下的dump.json文件)。
+* `dump.json`： 保存API或Cell前反向数据的统计量信息。包含dump数据的API名称或Cell名称，各数据的dtype、 shape、max、min、mean、L2norm（L2范数，平方根）统计信息以及当配置summary_mode="md5"时的CRC-32数据。具体介绍可参考[dump.json文件说明](./27.dump_json_instruction.md#2-mindspore-场景下的-dumpjson-文件)。
+* `dump_error_info.log`: 仅在dump工具报错时拥有此记录日志，用于记录dump错误日志。
 * `stack.json`：API/Cell的调用栈信息。
 * `construct.json`：分层分级结构，level为L1时，construct.json内容为空。
 
 dump 过程中，npy 文件在对应API或者模块被执行后就会落盘，而 json 文件则需要在正常执行 PrecisionDebugger.stop() 后才会写入完整数据，因此，程序异常终止时，被执行API对应的 npy 文件已被保存，但 json 文件中的数据可能丢失。
 
-动态图场景下使能 PSJit 或 PIJit，装饰特定 Cell 或 function，被装饰的部分会全部/部分使能**静态图**流程。
+动态图场景下使用 `mindspore.jit` 装饰特定 Cell 或 function 时，被装饰的部分会被编译成**静态图**执行。
+
+- config.json 文件配置 level 为 L0 或 mix，且 MindSpore 版本不低于 2.7.0 时， 若存在 construct 方法被 `mindspore.jit` 装饰的 Cell 对象，则 dump_path 下将生成 `graph` 与 `pynative` 目录，分别存放 construct 方法被 `mindspore.jit` 装饰的 Cell 对象的精度数据、其它Cell 或 API 对象的精度数据。示例如下：
 
-- PSJit 场景下 config.json 文件配置 level 为 L1 时，被 PSJit 装饰的部分也作为 API 被 dump 到对应目录；配置 level 为 L2 时，则只会 dump 用户网络中静态图流程下的相关 kernel，其结果目录同jit_level 为 O0/O1 时的静态图 dump 相同。
-- PIJit 场景下 config.json 文件配置 level 为 L1 时，会被还原为动态图，按 API 粒度进行 dump；配置 level 为 L2 时，则只会 dump 用户网络中静态图流程下的相关 kernel。
+```lua
+├── dump_path
+│   ├── graph
+│   |   ├── step0
+│   |   |   ├── rank0
+│   |   │   |   ├── dump_tensor_data
+|   |   |   |   |   ├── ...
+│   |   |   |   ├── dump.json
+│   |   |   |   ├── stack.json
+│   |   |   |   └── construct.json
+│   |   |   ├── ...
+│   ├── pynative
+│   |   ├── step0
+│   |   |   ├── rank0
+│   |   │   |   ├── dump_tensor_data
+|   |   |   |   |   ├── ...
+│   |   |   |   ├── dump.json
+│   |   |   |   ├── stack.json
+│   |   |   |   └── construct.json
+│   |   |   ├── ...
+```
 
+- config.json 文件配置 level 为 L1 时， 若 `mindspore.jit` 的 `capture_mode` 参数设置为 ast（原 PSJit 场景）, 则被装饰的部分也作为 API 被 dump 到对应目录；若 `mindspore.jit` 的 `capture_mode` 参数设置为 bytecode（原 PIJit 场景）, 则被装饰的部分会被还原为动态图，按 API 粒度进行 dump。
+
+- config.json 文件配置 level 为 L2 时， 仅会 dump 被 `mindspore.jit` 装饰部分的 kernel 精度数据，其结果目录同 jit_level 为 O0/O1 时的静态图 dump 结果相同。
 
 npy文件名的前缀含义如下：
 
@@ -414,12 +561,12 @@ npy文件名的前缀含义如下：
 | Primitive      | mindspore.ops.Primitive API数据      |
 | Mint           | mindspore.mint API数据              |
 | MintFunctional | mindspore.mint.nn.functional API数据 |
+| MintDistributed | mindspore.mint.distributed API数据 |
 | Distributed    | mindspore.communication.comm_func API数据     |
 | Jit            | 被"jit"装饰的模块或函数数据                |
 | Cell           | mindspore.nn.Cell 类（模块）数据           |
 
 
-
 ## 9.补充说明
 
 ### 9.1 修改 API 支持列表

msprobe/docs/07.accuracy_checker_PyTorch.md

@@ -13,9 +13,9 @@ b. 在预检 dump 时可以选择由工具构造随机数获得 dump 数据或
 1. 在 NPU 和 GPU 环境下分别安装 msprobe。详见[ msprobe 安装](./01.installation.md)章节。
 2. 在 NPU 训练脚本内添加 msprobe 工具 dump 接口 PrecisionDebugger，采集待预检数据。注意需要配置 level="L1"。
 3. 将 NPU 环境下 dump 的预检数据拷贝至 GPU 环境。
-4. 在 NPU 和 GPU 环境下分别执行 run_ut，生成的结果最终用于 api_precision_compare.py 函数的输入。详见 [3 离线预检操作指导](#3-离线预检操作指导)。
+4. 在 NPU 和 GPU 环境下分别执行 run_ut，生成的结果最终用于 api_precision_compare 的输入。详见 [3 离线预检操作指导](#3-离线预检操作指导)。
 5. 将 NPU 和 GPU 执行 run_ut 生成的 `accuracy_checking_details_{timestamp}.csv` 结果文件拷贝至同一环境下。
-6. 运行 api_precision_compare.py，输出结果为预检操作的最终结果。详见 [5 预检结果比对](#5-预检结果比对)章节。
+6. 运行 api_precision_compare，输出结果为预检操作的最终结果。详见 [5 预检结果比对](#5-预检结果比对)章节。
 
 ## 3 离线预检操作指导