# parser

**Repository Path**: zhan-jun/parser

## Basic Information

- **Project Name**: parser
- **Description**: Ascend CANN Parser
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 137
- **Created**: 2023-09-18
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Ascend CANN Parser


Ascend CANN Parser（简称parser）配合TF_Adapter、 ATC工具、IR构图等使用，开发者通过以上工具，借助parser能方便地将第三方框架的算法表示转换成Ascend IR，充分利用昇腾AI处理器卓越的运算能力。
![parser系统框架](https://images.gitee.com/uploads/images/2020/1015/151426_71a73e7e_7876749.png "parser系统框架.PNG")

## 目录结构介绍
```angular2html
parser
├── inc                                #  相关头文件
├── parser                            
|   ├── caffe                          #  caffe模型转换为Ascend IR
|   ├── common                         #  转换使用的公共接口
|   ├── func_to_graph                  #  Convert the tensorflow functionDefs in the input model file to single GraphDefs
|   ├── onnx                           #  onnx模型转换为Ascend IR
|   ├── tensorflow                     #  tensorflow模型转换为Ascend IR
├── tests                              #  DT测试目录
```


## 环境准备

parser支持源码编译，进行源码编译前，首先确保你有昇腾910AI处理器的环境，同时确保系统满足以下要求：

- 编译环境已安装CANN开发套件包（Ascend-cann-toolkit_\<soc_version>\_linux\_\<arch>），CANN开发套件软件包请从[Link](https://www.hiascend.com/developer/download/community/result?module=cann)获取。支持的操作系统、安装依赖及安装步骤请参见对应的[用户手册](https://hiascend.com/document/redirect/CannCommunityInstSoftware)的“CANN软件包支持的操作系统”与“安装开发环境”章节。

**说明:** Parser仓源代码与CANN软件包存在配套关系，源码编译前请获取并安装对应版本的CANN软件包。

- GCC == 7.X (建议7.5.0)
- CMake >= 3.20.0 (建议3.20.0)
- Autoconf >= 2.64
- Libtool >= 2.4.6
- Automake >= 1.15.1


## 代码下载

  ```bash
  $ git clone https://gitee.com/ascend/parser.git
  $ cd parser
  $ git submodule init && git submodule update
  ```


## 编译

Parser仓提供一键式编译能力,具体可以通过`bash build.sh -h`查看：

```bash
bash build.sh --ascend_custom_path=${CANN_INSTALL_PATH}
```
`ascend_custom_path`默认路径为`/usr/local/Ascend/latest`，编译完成后会在output/package目录下生成`CANN-parser-linux.{x86_64/aarch64}.run`包


## 本地验证（UT/ST）
Parser仓提供一键式编译执行开发者测试,详细配置可通过`bash tests/run_test.sh -h`查看
```bash
bash tests/run_test.sh -u --ascend_custom_path=${CANN_INSTALL_PATH}
```
`ascend_custom_path`默认路径为`/usr/local/Ascend/latest`


## 安装

编译完成后，可通过如下命令安装或回滚：
```shell
# 安装：
./CANN-parser-linux.{x86_64/aarch64}.run --full --quiet --install-path=${CANN_INSTALL_PATH}
# 回滚：
./CANN-parser-linux.{x86_64/aarch64}.run --rollback --quiet --install-path=${CANN_INSTALL_PATH}
```


## 贡献指南

针对Parser仓，开发者准备本地代码与提交PR时需要重点关注如下几点：

1. 请输出满足Google编程规范的代码，详细可参见[Google 开源项目风格指南 ](https://zh-google-styleguide.readthedocs.io/en/latest/)。
2. 提交PR时，请按照PR模板仔细填写本次PR的业务背景、目的、方案等信息。
3. 若您的修改不是简单的bug修复，而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等，请务必先通过Issue进行方案讨论，以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”，亦可通过提交Issue进行方案讨论。