项目目录
详细目录层级介绍如下
本章罗列的部分目录是可选的,请以实际交付件为准。尤其单算子目录,不同场景下交付件有差异,具体说明如下
├── cmake # 项目工程编译目录
│ ├── aclnn_ops_transformer.h.in # aclnn汇总头文件模板
│ └── ...
├── common # 项目公共头文件和公共代码
│ ├── CMakeLists.txt
│ ├── inc # 公共头文件目录
│ └── src # 公共代码目录
├── experimental # 用户自定义算子存放目录
│ ├── attention # 可选,用户开发的attention类算子目录
│ │ └── CMakeLists.txt
│ └── ...
│
├── ${op_class} # 算子分类,如attention、ffn、gmm类算子
│ ├${op_name} # 算子工程目录,${op_name}表示算子名(小写下划线形式)
│ │ ├── CMakeLists.txt # 算子cmakelist入口
│ │ ├── README.md # 算子介绍文档
│ │ ├── docs # 算子文档目录
│ │ │ └── aclnn${OpName}.md # 算子aclnn接口介绍文档,${OpName}表示算子名(大驼峰形式)
│ │ ├── examples # 算子调用示例目录
│ │ │ ├── test_aclnn_${op_name}.cpp # 算子通过aclnn调用的示例
│ │ │ └── test_geir_${op_name}.cpp # 算子通过geir调用的示例
│ │ ├── op_graph # 图融合相关实现
│ │ │ ├── CMakeLists.txt # op_graph侧cmakelist文件
│ │ │ ├── ${op_name}_graph_infer.cpp # InferDataType文件,实现算子数据类型推导
│ │ │ ├── ${op_name}_proto.h # 算子原型定义,用于图优化和融合阶段识别算子
│ │ │ └── fusion_pass # 算子融合规则目录
│ │ ├── op_host # Host侧实现
│ │ │ ├── config # 可选,二进制配置文件,若未配置工程自动生成
│ │ │ │ ├── ${soc_version} # 算子在NPU上配置的二进制信息,${soc_version}表示NPU型号
│ │ │ │ │ ├── ${op_name}_binary.json # 算子二进制配置文件
│ │ │ │ │ └── ${op_name}_simplified_key.ini # 算子SimplifiedKey配置信息
│ │ │ │ └── ...
│ │ │ ├── ${op_name}_def.cpp # 算子信息库,定义算子基本信息,如名称、输入输出、数据类型等
│ │ │ ├── ${op_name}_infershape.cpp # 可选,InferShape实现,根据算子形状推导输出shape,若未配置则输出shape与输入shape一样
│ │ │ ├── ${op_name}_tiling_${sub_case}.cpp # 可选,针对某些子场景下的Tiling优化,${sub_case}表示子场景,如${op_name}_tiling_arch35是针对arch35架构的优化,若无该文件表明该算子没有对应子场景的特定Tiling策略;注意:Tiling实现文件名须包含 `_tiling` 标识才会被编译系统识别并参与编译
│ │ │ ├── ${op_name}_tiling_${sub_case}.h # 可选,${sub_case}子场景下Tiling实现用的头文件
│ │ │ ├── ${op_name}_tiling.cpp # 可选,若无该文件表明对应场景下无Tiling实现(将张量划分为多个小块,区分数据类型进行并行计算)
│ │ │ ├── ${op_name}_tiling.h # 可选,Tiling实现用的头文件
│ │ │ └── CMakeLists.txt # Host侧cmakelist文件
│ │ ├── op_api # 可选,算子aclnn实现文件目录,若未配置工程自动生成
│ │ │ ├── aclnn_${op_name}.cpp # 算子aclnn接口实现文件
│ │ │ ├── aclnn_${op_name}.h # 算子aclnn接口实现头文件
│ │ │ ├── ${op_name}.cpp # 算子l0接口实现文件
│ │ │ ├── ${op_name}.h # 算子l0接口实现头文件
│ │ │ └── CMakeLists.txt
│ │ │── op_kernel # AI Core算子Device侧Kernel实现
│ │ │ ├── ${sub_case} # 可选,${sub_case}子场景使用的目录
│ │ │ │ ├── ${op_name}_${model}.h # 算子kernel实现文件,${model}表示用户自定义文件名后缀,通常为Tiling模板名
│ │ │ │ └── ...
│ │ │ ├── ${op_name}_tiling_key.h # 可选,TilingKey文件,定义Tiling策略的Key,标识不同划分方式,若未配置表明该算子无相应的Tiling策略
│ │ │ ├── ${op_name}_tiling_data.h # 可选,TilingData文件,存储Tiling策略相关配置信息,如块大小、并行度,若未配置表明该算子无相应的Tiling策略
│ │ │ ├── ${op_name}.cpp # Kernel入口文件,包含主函数和调度逻辑
│ │ │ └── ${op_name}.h # Kernel实现文件,定义Kernel头文件,包含函数声明、结构定义、逻辑实现
│ │ └── tests # 算子测试用例目录
│ │ ├── CMakeLists.txt
│ │ └── ut # 可选,UT测试用例,根据实际情况开发相应的用例
│ └── ...
├── docs # 项目相关文档目录
├── examples # 端到端算子开发和调用示例
│ ├── add_example # AI Core算子示例目录
│ │ ├── CMakeLists.txt # 算子编译配置文件
│ │ ├── examples # 算子使用示例目录
│ │ ├── op_graph # 算子构图相关目录
│ │ ├── op_host # 算子信息库、Tiling、InferShape相关实现目录
│ │ ├── op_kernel # 算子Kernel目录
│ │ └── tests # 算子测试用例目录
│ ├── CMakeLists.txt
│ └── README.md # 项目示例介绍文档
├── scripts # 脚本目录,包含自定义算子、Kernel构建相关配置文件
├── tests # 项目级测试目录
├── torch_extension # torch扩展目录,用于开放torch扩展api
│ ├── cann_ops_transformer # torch扩展module根目录
│ ├── common # torch扩展用到的公共能力目录
│ ├── docs # 扩展api文档目录(含开发规范torch_extension_guidelines.md)
│ ├── op_builder # OpBuilder基类,管理JIT编译与schema/meta注册
│ ├── ops # torch扩展算子api目录
│ │ ├── csrc # 算子api的c++实现文件目录
│ │ ├── graph_convert # 算子api适配torchair图模式的Converter目录
│ │ ├── ${api_name}.py # 算子api的Python前端定义与实现
│ │ └── __init__.py # ops子包入口,导出算子api与Converter
│ └── __init__.py # 包根入口,对外导出算子api接口
├── CMakeLists.txt # 项目工程cmakelist入口
├── CONTRIBUTING.md # 项目贡献指南文件
├── LICENSE # 项目开源许可证信息
├── OAT.xml # 配置脚本,代码仓工具使用,用于检查License是否规范
├── README.md # 项目工程总介绍文档
├── SECURITY.md # 项目安全声明文件
├── build.sh # 项目工程编译脚本
├── classify_rule.yaml # 组件划分信息
├── install_deps.sh # 项目安装依赖包脚本
├── requirements.txt # 项目的第三方依赖包
└── version.info # 项目版本信息