BMNETO 使用¶

编译ONNX模型¶

BMNETO是针对ONNX的模型编译器，可以把ONNX格式的model经过图编译优化后，转换成BMRuntime所需的文件。在编译模型的同时，可选择将每一个操作的NPU模型计算结果和CPU的计算结果进行对比，保证正确性。下面分别介绍该编译器的安装需求、安装步骤和使用方法。

安装需求
- python 3.x
- linux
- onnx == 1.7.0 (Opset version == 12)
- onnxruntime == 1.3.0
- protobuf >= 3.8.0
安装步骤

参见sdk初始化步骤(https://sophgo-doc.gitbook.io/sophonsdk3/)

使用方法

方式一：命令形式

Command name: python3 -m bmneto - BMNet compiler command for ONNX model

python3 -m bmneto [--model=<path>] \
                  [--input_names=<string>] \
                  [--shapes=<string>] \
                  [--outdir=<path>] \
                  [--target=<name>] \
                  [--net_name=<name>] \
                  [--opt=<value>] \
                  [--dyn=<bool>] \
                  [--cmp=<bool>] \
                  [--mode=<string>] \
                  [--descs=<string>] \
                  [--enable_profile=<bool>] \
                  [--output_names=<string>] \
                  [--list_ops]

参数介绍如下：

参数dyn=false表示使用静态编译，dyn=true表示使用动态编译。静态编译意思是model编译后，在runtime时只能运行编译所设置的shapes。动态编译意思是model编译后，runtime时可以运行任意shapes，只要实际shapes中的数值小于等于编译所设置shapes中的数值。一般来说，动态编译后神经网络在芯片上的性能要小于等于静态编译。所以一般建议动态编译用于实际网络的shapes会大范围变化的情况，如果shapes固定或者只需要几种shapes，建议采用静态编译。关于静态编译下如何支持若干种shapes，请见bmodel说明。

表 7 bmneto参数说明¶
args	type	Description
model	string	Necessary. ONNX model (.onnx) path
input_names	string	Optional. Set name of all network inputs one by one in sequence. Format “name1,name2,name3”
shapes	string	Necessary. Shapes of all inputs, default use the shape in prototxt, format [x,x,x,x],[x,x]…, these correspond to inputs one by one in sequence
target	string	Optional. BM1684 or BM1684X; default: BM1684
outdir	string	Optional. Output directory, default “compilation”
net_name	string	Optional. Name of the network, default “network”
opt	int	Optional. Optimization level. Option: 0, 1, 2, default 1.
dyn	bool	Optional. Use dynamic compilation, default false.
cmp	bool	Optional. Check result during compilation. Default: true
mode	string	Optional. Set bmneto mode. Option: compile, GenUmodel, check. Default: compile.
descs	string	Optional. Describe data type and value range of some input in format: “[ index, data format, lower bound, upper bound ]”, where data format could be fp32, int64. For example, [0, int64, 0, 100], meaning input of index 0 has data type as int64 and values in [0, 100). If no description of some input given, the data type will be fp32 as default and uniformly distributed in 0 ~ 1.
enable_profile	bool	Optional. Enable profile log. Default: false
output_names	string	Optional. Set name of all network outputs one by one in sequence. Format “name1,name2,name2”
list_ops		Optional. List supported ops.

方式二：python接口

bmneto的python接口如下：

import bmneto
## compile fp32 model
bmneto.compile(
  model = "/path/to/.pth",        ## Necessary
  outdir = "xxx",                 ## Necessary
  target = "BM1684",              ## Necessary
  shapes = [[x,x,x,x], [x,x,x]],  ## Necessary
  net_name = "name",              ## optional
  input_names = ['name0','name1'] ## optional
  opt = 2,                        ## optional, if not set, default equal to 1
  dyn = False,                    ## optional, if not set, default equal to False
  cmp = True,                     ## optional, if not set, default equal to True
  enable_profile = True           ## optional, if not set, default equal to False
  descs = [[0, int32, 0, 128]]    ## optional, if not set, default equal to [[x, float32, 0, 1]]
  output_names = ['oname0','oname1']  ## optional, if not set, default equal to graph output names
)

以下是list_ops的python接口。

import bmneto
## List all supported ops
bmneto.list_ops()

以下是check_graph的python接口。

import bmneto
## Check supported ops in model
bmneto.check_graph(MODEL_FILE)

bmneto输出和log

bmneto若成功，输出的log最后会看到以下信息。

######################################
# Store bmodel of BMCompiler.
######################################

bmneto成功后，将在指定的文件夹中生成一个compilation.bmodel的文件，该文件则是转换成功的bmodel，用户可以重命名。

若用户在bmneto时使用了cmp=true模式，则会在指定的文件夹中生成一个input_ref_data.dat和一个output_ref_data.dat，分别是ONNXruntime产生的网络输入参考数据和网络输出参考数据，可用于bmrt_test验证生成的bmodel在芯片运行时结果是否正确。

若没有上述信息，则bmneto失败。目前失败的话，用户可以修改opt优化选项，可能其它优化级别会成功，从而不会耽误用户部署。然后请用户将失败的问题告知我们的客户支持。

常见问题¶

pytorch转换onnx示例

model = ExampleModel() # or torch.load(model_path)
dummy_input = Variable(torch.randn(input_shape))
dummy_output = model(dummy_input)
torch.onnx.export(model,
                  dummy_input,
                  new_name,
                  opset_version=12,  # opset version must be 12
                  example_outputs = dummy_output,
                  )