# 查看中间文件
## 概述
在图模式`set_context(mode=GRAPH_MODE)`下运行用MindSpore编写的模型时,若配置中设置了`set_context(save_graphs=True)`,运行时会输出一些图编译过程中生成的中间文件,我们称为IR文件。当前主要有两种格式的IR文件:
- ir后缀结尾的IR文件:一种比较直观易懂的以文本格式描述模型结构的文件,可以直接用文本编辑软件查看。可以通过设置环境变量`export MS_DEV_SAVE_GRAPTHS_SORT_MODE=1`打印异序排序方式的ir文件。可以通过将该环境变量设置为其他值来切换为打印原来的排序方式的ir文件。
- dot后缀结尾的IR文件:若在配置中设置了`set_context(save_graphs=True, save_graph_dot=True)`, 运行时会输出后缀为dot的ir文件。该文件描述了不同节点间的拓扑关系,可以用[graphviz](http://graphviz.org)将此文件作为输入生成图片,方便用户直观地查看模型结构。对于算子比较多的模型,推荐使用可视化组件[MindInsight](https://www.mindspore.cn/mindinsight/docs/zh-CN/r2.0.0-alpha/dashboard.html#计算图可视化)对计算图进行可视化。
## 如何保存IR
通过`set_context(save_graphs=True)`来保存各个编译阶段的中间代码。被保存的中间代码有两种格式,默认保存后缀名为`.ir`的文本格式的ir文件。如果设置`set_context(save_graphs=True, save_graph_dot=True)`会打印后缀名为`.dot`的图形化格式的ir文件。当网络规模不大时,建议使用更直观的图形化格式来查看,当网络规模较大时建议使用更高效的文本格式来查看。
`.dot`文件可以通过graphviz转换为图片格式来查看,例如将dot转换为png的命令是`dot -Tpng *.dot -o *.png`。
在训练脚本`train.py`中,我们在`set_context`函数中添加如下代码,运行训练脚本时,MindSpore会自动将编译过程中产生的IR文件存放到指定路径。
```python
if __name__ == "__main__":
set_context(save_graphs=True, save_graph_dot=True, save_graphs_path="path/to/ir/files")
```
执行训练命令后,在指定的路径下生成了若干个文件:
```text
.
├──00_parse_0000.ir
├──00_parse_0001.dot
├──01_symbol_resolve_0002.ir
├──01_symbol_resolve_0003.dot
├──02_combine_like_graphs_0004.ir
├──02_combine_like_graphs_0005.dot
├──03_inference_opt_prepare_0006.ir
├──03_inference_opt_prepare_0007.dot
├──04_abstract_specialize_0008.ir
├──04_abstract_specialize_0009.dot
...
```
其中以数字下划线开头的IR文件是在前端编译图过程中生成的,编译过程中各阶段分别会保存一次计算图。下面介绍图编译过程中比较重要的阶段:
- `parse`阶段负责解析入口函数,该阶段会初步生成MindIR,如果查看IR文件,我们能观察到该阶段仅仅解析了顶层Cell的图信息;
- `symbol_resolve`阶段负责进一步解析入口函数,主要是递归解析入口函数直接或间接引用到的其他函数和对象。如果使用了尚不支持的语法,一般会在此阶段出错;
- `abstract_specialize`阶段,会根据输入信息推导出IR中所有节点的数据类型和形状信息。当需要查看IR中具体算子的形状或数据类型,可查看该IR文件;
- `optimize`阶段负责硬件无关的优化,自动微分与自动并行功能也是在该阶段展开。该阶段又可细分为若干个子阶段,在IR文件列表中,其中以`opt_pass_[序号]`为前缀的文件分别是这些子阶段结束后保存的IR文件,非框架开发人员无需过多关注;
- `validate`阶段负责校验编译出来的计算图,如果到此阶段IR中还有仅临时使用的内部算子,则会报错退出;
- `task_emit`阶段负责将计算图传给后端进一步处理;
- `execute`阶段负责启动执行图流程,该阶段的IR图是前端编译阶段的最终图。
此外,后端由于比较贴近底层,后端优化过程中保存的其他IR文件(如以`hwopt`开头的文件)非框架开发人员也无需过多关注。非框架开发人员仅需查看名为`graph_build_[图序号]_[IR文件序号].ir`的文件,即经过前后端全部优化后的IR。
>由于后端以子图为单位进行优化,故可能会保存多份文件,与前端多个子图都保存在同一文件中的机制不同。
## IR文件解读
下面以一个简单的例子来说明IR文件的内容,运行该脚本:
```python
import mindspore as ms
import mindspore.nn as nn
from mindspore import ops
ms.set_context(mode=ms.GRAPH_MODE)
ms.set_context(save_graphs=True, save_graphs_path="./")
class Net(nn.Cell):
def __init__(self):
super().__init__()
self.add = ops.Add()
self.sub = ops.Sub()
self.mul = ops.Mul()
self.div = ops.Div()
def func(x, y):
return self.div(x, y)
def construct(self, x, y):
a = self.sub(x, 1)
b = self.add(a, y)
c = self.mul(b, self.func(a, b))
return c
input1 = ms.Tensor(3, ms.float32)
input2 = ms.Tensor(2, ms.float32)
net = Net()
out = net(input1, input2)
print(out)
```
### ir文件介绍
使用文本编辑软件(例如`vi`)打开执行完后输出的IR文件`04_abstract_specialize_0012.ir`,内容如下所示(此处版本为MindSpore 2.0,后续版本中内容可能会有一些细微变化):
```text
1 #IR entry : @1_Default_wrapper.24
2 #Total subgraph: 3
3
4 #attrs :
5 #Total params : 2
6
7 %para1_x :
8 %para2_y :
9
10 subgraph attr:
11 undeterminate : 0
12 subgraph instance: 2_Default.23 : 0x556cab47cd00
13 # In file testir1.py:19/ def construct(self, x, y):/
14 subgraph @2_Default.23(%para3_x, %para4_y) {
15 %0(a) = Sub(%para3_x, Tensor(shape=[], dtype=Float32, value=1)) {instance name: sub} primitive_attrs: {output_names: [output], input_names: [x, y]}
16 : (, ) -> ()
17 # scope: (Default)
18 # In file testir1.py:20/ a = self.sub(x, 1)/
19 %1(b) = Add(%0, %para4_y) {instance name: add} primitive_attrs: {output_names: [output], input_names: [x, y]}
20 : (, ) -> ()
21 # scope: (Default)
22 # In file testir1.py:21/ b = self.add(a, y)/
23 %2([CNode]5) = call @3_func.22(%0, %1)
24 : (, ) -> ()
25 # scope: (Default)
26 # In file testir1.py:22/ c = self.mul(b, self.func(a, b))/
27 %3(c) = Mul(%1, %2) {instance name: mul} primitive_attrs: {output_names: [output], input_names: [x, y]}
28 : (, ) -> ()
29 # scope: (Default)
30 # In file testir1.py:22/ c = self.mul(b, self.func(a, b))/
31 Return(%3)
32 : ()
33 # scope: (Default)
34 # In file testir1.py:23/ return c/
35 }
36 # order:
37 # 1: @2_Default.23:a{[0]: ValueNode `` Sub, [1]: x, [2]: ValueNode `` Tensor(shape=[], dtype=Float32, value=1)}
38 # 2: @2_Default.23:b{[0]: ValueNode `` Add, [1]: a, [2]: y}
39 # 3: @2_Default.23:[CNode]5{[0]: ValueNode `` 3_func.22, [1]: a, [2]: b}
40 # 4: @2_Default.23:c{[0]: ValueNode `` Mul, [1]: b, [2]: [CNode]5}
41 # 5: @2_Default.23:[CNode]17{[0]: ValueNode `` Return, [1]: c}
42
43
44 subgraph attr:
45 undeterminate : 0
46 subgraph instance: 3_func.22 : 0x556cab481200
47 # In file testir1.py:16/ def func(x, y):/
48 subgraph @3_func.22(%para5_x, %para6_y) {
49 %0([CNode]19) = Div(%para5_x, %para6_y) {instance name: div} primitive_attrs: {output_names: [output], input_names: [x, y]}
50 : (, ) -> ()
51 # scope: (Default)
52 # In file testir1.py:17/ return self.div(x, y)/
53 Return(%0)
54 : ()
55 # scope: (Default)
56 # In file testir1.py:17/ return self.div(x, y)/
57 }
58 # order:
59 # 1: @3_func.22:[CNode]19{[0]: ValueNode `` Div, [1]: x, [2]: y}
60 # 2: @3_func.22:[CNode]21{[0]: ValueNode `` Return, [1]: [CNode]19}
61
62
63 subgraph attr:
64 subgraph instance: 1_Default_wrapper.24 : 0x556cab47b0e0
65 # In file testir1.py:19/ def construct(self, x, y):/
66 subgraph @1_Default_wrapper.24() {
67 %0([CNode]6) = call @2_Default.23(%para1_x, %para2_y)
68 : (, ) -> ()
69 # scope: (Default)
70 Return(%0)
71 : ()
72 # scope: (Default)
73 # In file testir1.py:23/ return c/
74 }
75 # order:
76 # 1: @1_Default_wrapper.24:[CNode]6{[0]: ValueNode `` 2_Default.23, [1]: x, [2]: y}
77 # 2: @1_Default_wrapper.24:[CNode]18{[0]: ValueNode `` Return, [1]: [CNode]6}
```
以上内容可分为两个部分,第一部分为图的输入信息,第二部分为图的结构信息:
- 第1行告诉了我们该网络的顶图名称 `1_construct_wrapper.24`,也就是入口图。
- 第2行告诉我们该网络解析出来的图的数量,该IR文件展示了三张图的信息。 分别为第63行的入口图`1_construct_wrapper.24`;第44行的图`3_func.22`,对应着网络中定义的函数`func(x, y)`;第10行的图`2_construct.23`,即对应`construct`函数。
- 第5行告诉了我们该网络有多少个输入。
- 第7-8行是输入列表,遵循`%para[序号]_[name] : <[data_type]x[shape]>`的格式。
对于具体的图来说(此处我们以图`2_construct.23`为例):
- 第10-41行展示了图结构的信息,图中含有若干个节点,即`CNode`。该图包含`Sub`、`Add`、`Mul`这些已经在`__init___`函数中定义过的算子。
- 第23行以`call @3_func.22`的形式,调用了图`3_func.22`,对应脚本中调用函数`func`执行两数相除的行为。
- 第36-41行表示图中计算节点的执行序,与代码执行的先后顺序对应。格式为:`序号: 所属图名称:节点名称{[0]: 第一个输入的信息, [1]: 第二个输入的信息, ...}`。 对于`CNode`而言,第一个输入表示该节点承载的计算方式。
`CNode`([ANF-IR的设计请查看](https://www.mindspore.cn/docs/zh-CN/r2.0.0-alpha/design/mindir.html#文法定义))的信息遵循如下格式,从左到右分别为序号、节点名称-debug_name、算子名称-op_name、输入节点-arg、节点的属性-primitive_attrs、输入和输出的规格、源码解析调用栈等信息。
由于ANF图为单向无环图,所以此处仅根据输入关系来体现节点与节点的连接关系。关联代码行则体现了`CNode`与脚本源码之间的关系,例如第15行表明该节点是由脚本中`a = self.sub(x, 1)`这一行解析而来。
```text
%[序号]([debug_name]) = [op_name]([arg], ...) primitive_attrs: {[key]: [value], ...}
: (<[输入data_type]x[输入shape]>, ...) -> (<[输出data_type]x[输出shape]>, ...)
# 关联代码行
```
关于关联代码行的说明:
- 代码行展示有两种模式,第一种是显示完整的调用栈,前端或后端最后生成的IR文件(如前端的`15_execute_0141.ir`和后端的`graph_build_0_136.ir`)
按此模式展示代码行;第二种为了减小文件的体积,只显示第一行,即省去了调用过程(如`04_abstract_specialize_0012.ir`)。
- 如果算子是反向传播算子,关联代码行除了会显示本身的代码,还会显示对应的正向代码,通过“Corresponding forward node candidate:”标识。
- 如果算子是融合算子,关联代码行会显示出融合的相关代码,通过“Corresponding code candidate:”标识,其中用分隔符“-”区分不同的代码。
> - 经过编译器的若干优化处理后,节点可能经过了若干转换(如算子拆分、算子融合等),节点的源码解析调用栈信息与脚本可能无法完全一一对应,这里仅作为辅助手段。
> - 在后端经过算子选择阶段后,输入输出规格信息(即`:`后内容)会有两行。第一行表示为`HOST`侧的规格信息,第二行为`DEVICE`侧的规格信息。
### 异序ir文件介绍
使用文本编辑软件(例如`vi`)打开在设置了环境变量并执行完后输出的IR文件`04_abstract_specialize_0008.ir`,内容如下所示(此处版本为MindSpore 2.0,后续版本中内容可能会有一些细微变化):
```text
1 #IR entry : @1_construct.Default_wrapper.22
2 #Total subgraph: 3
3
4 #attrs :
5 #Total params : 2
6
7 %para1_x :
8 %para2_y :
9
10 subgraph attr:
11 subgraph instance: 1_construct.Default_wrapper.22 : 0x5568122fcf90
12 # In file kldtest.py:19/ def construct(self, x, y):/
13 subgraph @1_construct.Default_wrapper.22() {
14 %0([CNode]2) = call @2_construct.Default.23(%para1_x, %para2_y)
15 : (, ) -> ()
16 # scope: (Default)
17 Return(%0)
18 : ()
19 # scope: (Default)
20 # In file kldtest.py:23/ return c/
21 }
22 # order:
23 # 1: @1_construct.Default_wrapper.22:[CNode]2{[0]: ValueNode `` 2_construct.Default.23, [1]: x, [2]: y}
24 # 2: @1_construct.Default_wrapper.22:[CNode]4{[0]: ValueNode `` Return, [1]: [CNode]2}
25
26
27 subgraph attr:
28 undeterminate : 0
29 subgraph instance: 2_construct.Default.23 : 0x5568122fe9c0
30 # In file kldtest.py:19/ def construct(self, x, y):/
31 subgraph @2_construct.Default.23(%para3_x, %para4_y) {
32 %0(a) = Sub(%para3_x, Tensor(shape=[], dtype=Float32, value=1)) {instance name: sub} primitive_attrs: {output_names: [output], input_names: [x, y]}
33 : (, ) -> ()
34 # scope: (Default)
35 # In file kldtest.py:20/ a = self.sub(x, 1)/
36 %1(b) = Add(%0, %para4_y) {instance name: add} primitive_attrs: {output_names: [output], input_names: [x, y]}
37 : (, ) -> ()
38 # scope: (Default)
39 # In file kldtest.py:21/ b = self.add(a, y)/
40 %2([CNode]9) = call @3_func.24(%0, %1)
41 : (, ) -> ()
42 # scope: (Default)
43 # In file kldtest.py:22/ c = self.mul(b, self.func(a, b))/
44 %3(c) = Mul(%1, %2) {instance name: mul} primitive_attrs: {output_names: [output], input_names: [x, y]}
45 : (, ) -> ()
46 # scope: (Default)
47 # In file kldtest.py:22/ c = self.mul(b, self.func(a, b))/
48 Return(%3)
49 : ()
50 # scope: (Default)
51 # In file kldtest.py:23/ return c/
52 }
53 # order:
54 # 1: @2_construct.Default.23:a{[0]: ValueNode `` Sub, [1]: x, [2]: ValueNode `` Tensor(shape=[], dtype=Float32, value=1)}
55 # 2: @2_construct.Default.23:b{[0]: ValueNode `` Add, [1]: a, [2]: y}
56 # 3: @2_construct.Default.23:[CNode]9{[0]: ValueNode `` 3_func.24, [1]: a, [2]: b}
57 # 4: @2_construct.Default.23:c{[0]: ValueNode `` Mul, [1]: b, [2]: [CNode]9}
58 # 5: @2_construct.Default.23:[CNode]18{[0]: ValueNode `` Return, [1]: c}
59
60
61 subgraph attr:
62 undeterminate : 0
63 subgraph instance: 3_func.24 : 0x556812302e20
64 # In file kldtest.py:16/ def func(x, y):/
65 subgraph @3_func.24(%para3_x, %para4_y) {
66 %0([CNode]20) = Div(%para3_x, %para4_y) {instance name: div} primitive_attrs: {output_names: [output], input_names: [x, y]}
67 : (, ) -> ()
68 # scope: (Default)
69 # In file kldtest.py:17/ return self.div(x, y)/
70 Return(%0)
71 : ()
72 # scope: (Default)
73 # In file kldtest.py:17/ return self.div(x, y)/
74 }
75 # order:
76 # 1: @3_func.24:[CNode]20{[0]: ValueNode `` Div, [1]: x, [2]: y}
77 # 2: @3_func.24:[CNode]21{[0]: ValueNode `` Return, [1]: [CNode]20}
```
以上内容,从顶图开始,以拓扑排序的方式展示了所有图的信息。
### dot文件介绍
可以用[graphviz](http://graphviz.org)将`dot`格式的IR文件作为输入生成图片。例如,在Linux操作系统下,可以通过以下命令转换成一张PNG图片。
```shell
dot -Tpng -o 04_abstract_specialize_0014.png 04_abstract_specialize_0014.dot
```
转换后的图片如下所示,我们可以直观地查看模型结构。不同的黑框区分了不同的子图,图与图之间的蓝色箭头表示相互之间的调用。蓝色区域表示参数,矩形表示图的参数列表,六边形和黑色箭头表示该参数作为CNode的输入参与计算过程。黄色矩形表示CNode节点,从图中可以看出,CNode输入从下标0开始,第0个输入(即紫色或绿色区域)表示该算子将要进行怎样的计算,通过虚箭头连接。类型一般为算子原语,也可以是另一张图。下标1之后的输入则为计算所需要的参数。
![04_abstract_specialize_0014.png](./images/dot_to_png.png)
对于算子比较多的模型,图片会过于庞大,推荐使用可视化组件[MindInsight](https://www.mindspore.cn/mindinsight/docs/zh-CN/r2.0.0-alpha/dashboard.html#计算图可视化)对计算图进行可视化。
## 如何根据analyze_fail.dat文件分析图推导失败的原因
MindSpore在编译图的过程中,经常会出现`abstract_specialize`阶段的图推导失败的报错,通常我们能根据报错信息以及analyze_fail.dat文件,来定位出脚本中存在的问题。
### 例子1:参数数量不匹配
```python
1 import mindspore as ms
2 import mindspore.nn as nn
3
4 from mindspore.nn import Cell
5 from mindspore import ops
6
7
8 ms.set_context(mode=ms.GRAPH_MODE)
9 ms.set_context(save_graphs=True)
10
11 class Net(nn.Cell):
12 def __init__(self):
13 super().__init__()
14 self.add = ops.Add()
15 self.sub = ops.Sub()
16 self.mul = ops.Mul()
17 self.div = ops.Div()
18
19 def func(x, y):
20 return self.div(x, y)
21
22 def construct(self, x, y):
23 a = self.sub(x, 1)
24 b = self.add(a, y)
25 c = self.mul(b, self.func(a, a, b))
26 return c
27
28 input1 = ms.Tensor(3, ms.float32)
29 input2 = ms.Tensor(2, ms.float32)
30 net = Net()
31 out = net(input1, input2)
32 print(out)
```
会出现如下的报错:
```text
1 [EXCEPTION] ANALYZER(31946,7f6f03941740,python):2021-09-18-15:10:49.094.863 [mindspore/ccsrc/pipeline/jit/static_analysis/stack_frame.cc:85] DoJump] The parameters number of the function is 2, but the number of provided arguments is 3.
2 FunctionGraph ID : func.18
3 NodeInfo: In file test.py(19)
4 def func(x, y):
5
6 Traceback (most recent call last):
7 File "test.py", line 31, in
8 out = net(input1, input2)
9 File "/home/workspace/mindspore/mindspore/nn/cell.py", line 404, in __call__
10 out = self.compile_and_run(*inputs)
11 File "/home/workspace/mindspore/mindspore/nn/cell.py", line 682, in compile_and_run
12 self.compile(*inputs)
13 File "/home/workspace/mindspore/mindspore/nn/cell.py", line 669, in compile
14 _cell_graph_executor.compile(self, *inputs, phase=self.phase, auto_parallel_mode=self._auto_parallel_mode)
15 File "/home/workspace/mindspore/mindspore/common/api.py", line 542, in compile
16 result = self._graph_executor.compile(obj, args_list, phase, use_vm, self.queue_name)
17 TypeError: mindspore/ccsrc/pipeline/jit/static_analysis/stack_frame.cc:85 DoJump] The parameters number of the function is 2, but the number of provided arguments is 3.
18 FunctionGraph ID : func.18
19 NodeInfo: In file test.py(19)
20 def func(x, y):
21
22 The function call stack (See file '/home/workspace/mindspore/rank_0/om/analyze_fail.dat' for more details):
23 # 0 In file test.py(26)
24 return c
25 ^
26 # 1 In file test.py(25)
27 c = self.mul(b, self.func(a, a, b))
28 ^
```
以上的报错信息为:“TypeError: mindspore/ccsrc/pipeline/jit/static_analysis/stack_frame.cc:85 DoJump] The parameters number of the function is 2, but the number of provided arguments is 3...”。
表明`FunctionGraph ID : func.18`只需要2个参数,但是却提供了3个参数。从“The function call stack ...”中,可以知道出错的代码为:“In file test.py(25) ... self.func(a, a, b)”,易知是该处的函数调用传入参数的数目过多。
但如果报错信息不直观或者需要查看IR中已推导出的部分图信息,我们使用文本编辑软件(例如,vi)打开报错信息中的提示的文件(第22行括号中):`/home/workspace/mindspore/rank_0/om/analyze_fail.dat`,内容如下(此处版本为MindSpore 2.0,后续版本中内容可能会有一些细微变化):
```text
1 # 1.This file shows the parsed IR info when graph evaluating failed to help find the problem.
2 # 2.You can search the last `------------------------>` to the node which is inferred failed.
3 # 3.Refer to https://www.mindspore.cn/search?inputValue=analyze_fail.dat to get more instructions.
4 # ===============================================================================
5
6 subgraph attr:
7 subgraph instance: Default_wrapper.8 : 0x55b95477d120
8 # In file testir1.py:22/ def construct(self, x, y):/
9 subgraph @Default_wrapper.8(
10 %para1_x :
11 , %para2_y :
12 ) {
13
14 #------------------------> 0
15 %1([CNode]6) = call @Default.7(%para1_x, %para2_y)
16 :(, ) -> (``)
17 #scope: Default
18 Primitive::Return{prim_type=1}(%1)
19 :(``)
20 #scope: Default
21 # In file testir1.py:26/ return c/
22 }
23 # order:
24 # 1: @Default_wrapper.8:[CNode]6{[0]: ValueNode `` Default.7, [1]: x, [2]: y}
25 # 2: @Default_wrapper.8:[CNode]18{[0]: ValueNode `` Return, [1]: [CNode]6}
26
27
28 subgraph attr:
29 subgraph instance: Default.7 : 0x55b95477c800
30 # In file testir1.py:22/ def construct(self, x, y):/
31 subgraph @Default.7(
32 %para3_x :
33 , %para4_y :
34 ) {
35 %1(a) = DoSignaturePrimitive::S-Prim-Sub{prim_type=1}[output_names=["output"], input_names=["x", "y"]](%para3_x, I64(1))
36 :(, ) -> ()
37 #scope: Default
38 # In file testir1.py:23/ a = self.sub(x, 1)/
39 %2(b) = DoSignaturePrimitive::S-Prim-Add{prim_type=1}[output_names=["output"], input_names=["x", "y"]](%1, %para4_y)
40 :(, ) -> ()
41 #scope: Default
42 # In file testir1.py:24/ b = self.add(a, y)/
43
44 #------------------------> 1
45 %3([CNode]5) = call @func.20(%1, %1, %2)
46 :(, , ) -> (``)
47 #scope: Default
48 # In file testir1.py:25/ c = self.mul(b, self.func(a, a, b))/
49 %4(c) = DoSignaturePrimitive::S-Prim-Mul{prim_type=1}[output_names=["output"], input_names=["x", "y"]](%2, %3)
50 :(, ``) -> (``)
51 #scope: Default
52 # In file testir1.py:25/ c = self.mul(b, self.func(a, a, b))/
53 Primitive::Return{prim_type=1}(%4)
54 :(``)
55 #scope: Default
56 # In file testir1.py:26/ return c/
57 }
58 # order:
59 # 1: @Default.7:a{[0]: a, [1]: ValueNode `` 1, [2]: ValueNode `` Float32}
60 # 2: @Default.7:a{[0]: ValueNode `` S-Prim-Sub, [1]: x, [2]: ValueNode `` 1}
61 # 3: @Default.7:b{[0]: ValueNode `` S-Prim-Add, [1]: a, [2]: y}
62 # 4: @Default.7:[CNode]5{[0]: ValueNode `` func.20, [1]: a, [2]: a, [3]: b}
63 # 5: @Default.7:c{[0]: ValueNode `` S-Prim-Mul, [1]: b, [2]: [CNode]5}
64 # 6: @Default.7:[CNode]17{[0]: ValueNode `` Return, [1]: c}
65
66
67 #===============================================================================
68 # num of function graphs in stack: 2
```
`analyze_fail.dat`文件与前文介绍过的异序ir文件格式一致,唯一有区别的地方在于`analyze_fail.dat`文件中会指出推导出错的节点所在的位置。
我们不断搜索`------------------------>`并来到最后一处该箭头出现的位置,即第44行的`------------------------> 1`。该最后一处箭头指向了推导出错的节点,为`%3([CNode]5) = call @func.20(%1, %1, %2) ...`,表达了该节点在IR中的信息,如何查看analyze_fail.dat文件前文`异序ir文件介绍`一节中已经介绍,此处不再赘述。
根据`(%1, %1, %2)`可知,该节点的输入参数有三个。从源码解析调用栈中可以知道实际该函数为`self.func`,在脚本中的定义为`def dunc(x, y):...`。
在函数定义中,只需要两个参数,故会在此处出现推导失败的报错,我们需要修改脚本中传入的参数个数以解决该问题。
### 例子2:BiasAdd输入之间shape不匹配
```python
1 import numpy as np
2 import mindspore
3 from mindspore import nn, ops, set_context, Tensor, Parameter
4 from mindspore.common.initializer import initializer
5
6 class Net(nn.Cell):
7 def __init__(self):
8 super(Net, self).__init__()
9 self.weight = Parameter(initializer('normal', [32, 8]), name="weight")
10 self.bias = Parameter(initializer('zeros', [4]), name="bias")
11
12 self.matmul = ops.MatMul()
13 self.bias_add = ops.BiasAdd()
14
15 def construct(self, x1):
16 x = self.matmul(x1, self.weight)
17 x = self.bias_add(x, self.bias)
18 return x
19
20 net = Net()
21 x = Tensor(np.arange(3*32).reshape(3, 32), mindspore.float32)
22 out = net(x)
23 print('out', out.shape)
```
会出现如下的报错:
```text
Traceback (most recent call last):
File "test.py", line 22, in
out = net(x)
File "/home/workspace/mindspore/build/package/mindspore/nn/cell.py", line 573, in __call__
out = self.compile_and_run(*args)
File "/home/workspace/mindspore/build/package/mindspore/nn/cell.py", line 956, in compile_and_run
self.compile(*inputs)
File "/home/workspace/mindspore/build/package/mindspore/nn/cell.py", line 929, in compile
_cell_graph_executor.compile(self, *inputs, phase=self.phase, auto_parallel_mode=self._auto_parallel_mode)
File "/home/workspace/mindspore/build/package/mindspore/common/api.py", line 1076, in compile
result = self._graph_executor.compile(obj, args_list, phase, self._use_vm_mode())
ValueError: For 'BiasAdd', bias[0] shape must be equal to input_x[1] shape when data_format is NHWC or input_x[1] shape, but got bias[0] shape: 4, input_x[1] or input_x[1] shape: 8.
----------------------------------------------------
- The Traceback of Net Construct Code:
----------------------------------------------------
The function call stack (See file '/home/workspace/mindspore/rank_0/om/analyze_fail.dat' for more details. Get instructions about `analyze_fail.dat` at https://www.mindspore.cn/search?inputValue=analyze_fail.dat):
# 0 In file test.py(17)
x = self.bias_add(x, self.bias)
^
----------------------------------------------------
- C++ Call Stack: (For framework developers)
----------------------------------------------------
mindspore/core/ops/bias_add.cc:71 BiasAddInferShape
```
根据以上报错可知,是算子`BiasAdd`的第一个输入和第二个输入的`shape`不匹配导致的错误。为了进一步了解算子的`shape`是经过了什么样的变化,我们使用文本编辑软件(例如,vi)打开报错信息中的提示的文件:`/home/workspace/mindspore/rank_0/om/analyze_fail.dat`,内容如下(此处版本为MindSpore 2.0,后续版本中内容可能会有一些细微变化):
```text
1 # 1.This file shows the parsed IR info when graph evaluating failed to help find the problem.
2 # 2.You can search the last `------------------------>` to the node which is inferred failed.
3 # 3.Refer to https://www.mindspore.cn/search?inputValue=analyze_fail.dat to get more instructions.
4 # ===============================================================================
5
6 subgraph attr:
7 subgraph instance: Default_wrapper.1 : 0x55ef771b9dd0
8 # In file testir1.py:14/ def construct(self, x1):/
9 subgraph @Default_wrapper.1(
10 %para1_x1 :
11 , %para2_bias : [ : has_default
12 , %para3_weight : ][ : has_default
13 ) {
14
15 #------------------------> 0
16 %1([CNode]3) = call @Default.2(%para1_x1)
17 :() -> (``)
18 #scope: Default
19 Primitive::Return{prim_type=1}(%1)
20 :(``)
21 #scope: Default
22 # In file testir1.py:17/ return x/
23 }
24 # order:
25 # 1: @Default_wrapper.1:[CNode]3{[0]: ValueNode `` Default.2, [1]: x1}
26 # 2: @Default_wrapper.1:[CNode]4{[0]: ValueNode `` Return, [1]: [CNode]3}
27
28
29 subgraph attr:
30 subgraph instance: Default.2 : 0x55ef771b11a0
31 # In file testir1.py:14/ def construct(self, x1):/
32 subgraph @Default.2 parent: [subgraph @Default_wrapper.1](
33 %para4_x1 :
34 ) {
35 %1(x) = DoSignaturePrimitive::S-Prim-MatMul{prim_type=1}[output_names=["output"], transpose_a=Bool(0), input_names=["x1", "x2"], transpose_x2=Bool(0), transpose_x1=Bool(0), transpose_b=Bool( 0)](%para4_x1, %para3_weight)
36 :(, ][) -> ()
37 #scope: Default
38 # In file testir1.py:15/ x = self.matmul(x1, self.weight)/
39
40 #------------------------> 1
41 %2(x) = DoSignaturePrimitive::S-Prim-BiasAdd{prim_type=1}[output_names=["output"], format="NCHW", input_names=["x", "b"], data_format="NCHW"](%1, %para2_bias)
42 :(, ][) -> (``)
43 #scope: Default
44 # In file testir1.py:16/ x = self.bias_add(x, self.bias)/
45 Primitive::Return{prim_type=1}(%2)
46 :(``)
47 #scope: Default
48 # In file testir1.py:17/ return x/
49 }
50 # order:
51 # 1: @Default.2:x{[0]: ValueNode `` S-Prim-MatMul, [1]: x1, [2]: weight}
52 # 2: @Default.2:x{[0]: ValueNode `` S-Prim-BiasAdd, [1]: x, [2]: bias}
53 # 3: @Default.2:[CNode]5{[0]: ValueNode `` Return, [1]: x}
54
55
56 #===============================================================================
57 # num of function graphs in stack: 2/3 (Ignored 1 internal frames).
```
搜索`------------------------>`来到第41行,即推导出错的位置。根据`...(%1, %para2_bias) :(, ][) -> (``)`可知,算子`BiasAdd`的输入是`%1`和`%para2_bias`这两个节点。其中,`%1`的shape是`[3, 8]`,`%para2_bias`的shape是`[4]`,不符合算子API中`BiasAdd`算子的描述`bias (Tensor) - 偏置Tensor,shape为 (C)。C必须与 input_x 的通道维度C相同...`的要求,故此处报错。
因此,为了解决该问题,我们要么修改`%1`的shape,要么修改`%para2`(即`self.bias`)的shape。
- 如果修改`self.bias`的维度,只需要改成`self.bias = Parameter(initializer('zeros', [8]), name="bias")`。
- 如果修改`%1`的shape,我们先要明白`%1`是什么。根据第35行可知,这是一个`MatMul`算子,输出shape是`[3, 8]`。该算子的输入是`(%para4_x1, %para3_weight)`,第一个输入的shape是`[3, 32]`(即我们传入的参数`x`),第二个输入shape是`[32, 8]`(即`self.weight`)。为了满足和shape为`[4]`的数据`BiasAdd`的要求,需要使得`%1`的输出shape为`[3, 4]`,因此我们修改`self.weight`为`self.weight = Parameter(initializer('normal', [32, 4]), name="weight")`。]