cann-robotfusion pass sample：onnx文件代替导出onnx torch脚本

文件	最后提交记录	最后更新时间
data	fusion pass sample：onnx文件代替导出onnx torch脚本	4 个月前
gen_es_api	Initial commit	5 个月前
src	Initial commit	5 个月前
CMakeLists.txt	【PR】:【融合pass sample 】make install 安装pass so 到自定义融合pass目录	4 个月前
README.md	fusion pass sample：onnx文件代替导出onnx torch脚本	4 个月前

样例使用指导

功能描述

本样例为删除加零操作的自定义pass样例，提供在线推理与atc工具离线编译模型两种方式演示框架如何调用自定义pass完成图优化。本样例使用eager style api和融合接口实现。

目录结构

├── src
│   ├──add_zero_pass.cpp         // pass实现文件 
├── CMakeLists.txt               // 编译脚本
├── data         
|   ├──torch_gen_onnx.py         // torch脚本用于导出onnx
|   ├──torch_forward.py          // torch脚本用于在线推理
|—— gen_es_api
|   |——CMakeLists.txt            // 生成eager style api的编译脚本

环境要求

使用python及其依赖库版本：python>=3.8 、pytorch>=2.1
已完成相关环境准备。

实现步骤

定义类AddZeroPass继承PatternFusionPass。
重写基类PatternFusionPass中的3个函数：
- Patterns定义匹配模板，用于在整图中获取与该模板相同的拓扑。
- MeetRequirements对模板匹配到的拓扑进行筛选。
- Replacement定义替换部分。
注册AddZeroPass为自定义融合pass，执行阶段为BeforeInferShape。

程序编译

假设CANN软件包的安装目录为INSTALL_PATH, 例如/home/HwHiAiUser/Ascend/。

配置环境变量。

运行软件包中设置环境变量脚本，命令如下：
```
source ${ASCEND_PATH}/set_env.sh
```
${ASCEND_PATH}为CANN软件包安装目录下的cann路径。请替换相关软件包的实际安装路径，例如${INSTALL_PATH}/cann。
根据实际情况修改CMakeLists.txt文件中的如下信息。
- ASCEND_PATH：可以设置默认的软件包路径，如果通过set_env.sh设置了$ASCEND_HOME_PATH，无需修改。
- PASS_SO_DIR：可以设置自定义融合pass动态库安装目录名，默认为pass_so_dir。
- target_include_directories：需要包含的头文件，对于本示例，无需修改。如果是用户自行开发的代码，当需要添加头文件时，在示例下方直接增加行即可，注意不要删除原有项目。如果网络中有自定义算子，请增加自定义算子的原型定义头文件。
- target_link_libraries：需要链接的库，对于本示例，无需修改。如果是用户自行开发的代码，当需要添加链接库时，在示例下方直接增加行即可，注意不要删除原有项目。
  
  禁止链接软件包中的其他so，否则后续升级可能会导致兼容性问题。
执行如下命令生成eager style api

依次执行:
```
mkdir build && cd build
cmake ..
make generate_es_api
```
执行后，在build目录下产生generated_ops目录，内含es构图api的头文件及源码
临时步骤，执行如下命令生成es api对应的so，并拷贝到run包安装路径下。可以在make后增加参数-j<N>用于并行执行构建任务，N推荐选择CPU核心数或CPU核心数+1。
```
make esb_generated_shared
```
编译完成后，在build/gen_es_api目录下生成libesb_generated_shared.so 将so拷贝到ASCEND_PATH下lib64目录下。
```
cp gen_es_api/libesb_generated_shared.so ${ASCEND_PATH}/x86_64-linux/lib64
```
若为arm环境，目标路径调整为
```
cp gen_es_api/libesb_generated_shared.so ${ASCEND_PATH}/aarch64-linux/lib64
```
执行make命令编译自定义pass so，成功编译后通过make install将动态库文件libadd_zero_pass.so安装到自定义融合pass目录下。
```
make
make install
```

程序运行

配置环境变量(如已执行，跳过)。
- 运行软件包中设置环境变量脚本，命令如下：
```
source ${ASCEND_PATH}/set_env.sh
```
${ASCEND_PATH}请替换相关软件包的实际安装路径。
使用ATC离线推理。
- 设置环境变量，dump出编译过程中的模型图：
```
export DUMP_GE_GRAPH=1
```
- data目录中提供了当前sample对应场景的模型model.onnx。执行ATC工具命令(关于ATC工具的详细说明，请前往昇腾社区搜索ATC离线模型编译工具)，soc_version请根据实际环境修改：
```
atc --model=./model.onnx --framework=5 --soc_version=xxx --output=./model
```
- 日志中出现如下打印：
```
Define pattern for AddZeroPass
Define MeetRequirements for AddZeroPass
Define replacement for AddZeroPass
```
在线推理
- 设置环境变量，dump出编译过程中的模型图：
```
export DUMP_GE_GRAPH=1
```
- 进入data目录执行.py文件进行在线推理（在线推理请确保已安装torch_npu插件）：
```
python torch_forward.py
```
- 日志中出现如下打印：
```
Define pattern for AddZeroPass
Define MeetRequirements for AddZeroPass
Define replacement for AddZeroPass
```
查看运行结果
- 执行完成后，目录下生成一系列.pbtxt文件。对比以下dump图：
  - ge_onnx_xxxxx_PreRunBegin.pbtxt执行前dump图
  - ge_onnx_xxxxx_RunCustomPassBeforeInferShape.pbtxt执行InferShape前的自定义pass dump图
可以发现模型已按预期优化，即加零节点被删除。