cann/cannbot-skills算子README模板

📅 2026/7/12 23:13:13
cann/cannbot-skills算子README模板
{算子名称}【免费下载链接】cannbot-skillsCANNBot 是面向 CANN 开发的用于提升开发效率的系列智能体本仓库为其提供可复用的 Skills 模块。项目地址: https://gitcode.com/cann/cannbot-skills本模板用于编写开源算子 README 文档gitcode 仓。 文档存放路径operators/{operator_name}/README.md在线参考https://gitcode.com/cann/ops-math/blob/master/math/add/README.md产品支持情况[!NOTE]写作规范推荐表格形式罗列支持的产品型号并打 √。按产品实际支持情况填写产品顺序不要改变若新增产品需所有算子全量适配产品形态介绍参见昇腾产品形态说明仅算子支持麒麟芯片aclnn 不涉及产品是否支持Ascend 950PR/Ascend 950DT√Atlas A3 训练系列产品/Atlas A3 推理系列产品√Atlas A2 训练系列产品/Atlas A2 推理系列产品√Atlas 200I/500 A2 推理产品×Atlas 推理系列产品×Atlas 训练系列产品√Kirin xxx√功能说明[!NOTE]写作目标阐明算子功能、计算原理、参数规格、使用场景等。写作规范推荐无序列表形式一般包括如下维度算子功能必选以一句话形式简洁明了阐述功能计算公式可选复杂功能可借助公式介绍实现原理或不同场景下的计算过程其他维度可选支持无序列表拓展如计算示例、流程图等算子功能完成加法计算。计算公式$$ y x1 alpha \times x2 $$参数说明[!NOTE]写作目标阐明算子定义的参数含义、作用、规格等信息。写作规范采用表格形式一般包括如下维度参数名解释算子定义文件中的参数顺序保持一致如op_host/{op}_def.cpp或op_graph/{op}_proto.h输入/输出/属性明确参数定位默认是必选若为可选一般为可选输入/可选输出/可选属性描述提供参数含义、功能、使用场景等介绍包括与公式变量的映射关系数据类型参数支持的 data type可不带DT_前缀数据格式参数支持的数据排布方式可不带FORMAT_前缀其他维度可选支持表格字段扩展如 shape 规格等芯片差异表格里罗列所有芯片描述的并集差异化描述在表格外以产品1、产品2xx描述形式组织参数名输入/输出/属性描述数据类型数据格式x1输入公式中的输入x1。FLOAT、FLOAT16、INT32、INT64、INT16、INT8、UINT8、BOOL、COMPLEX128、COMPLEX64、BFLOAT16NDx2输入公式中的输入x2。FLOAT、FLOAT16、INT32、INT64、INT16、INT8、UINT8、BOOL、COMPLEX128、COMPLEX64、BFLOAT16NDalpha可选属性alpha的描述xxx。默认值为1.0。FLOAT-y输出公式中的y。FLOAT、FLOAT16、INT32、INT64、INT16、INT8、UINT8、BOOL、COMPLEX128、COMPLEX64、BFLOAT16NDAtlas 训练系列产品 不支持BFLOAT16。约束说明可选[!NOTE]写作目标阐明算子使用过程中的注意事项例如参数组合约束、适用场景、对业务影响、算子性能或精度等。写作规范本章为可选若无约束可不呈现本章内容若有请采用无序列表形式算子原生语义的通用约束不写从使用场景、硬件/软件资源、对系统/网络性能或精度影响等角度说明列出该算子在昇腾硬件上实现时的特有限制无调用说明[!NOTE]写作目标提供算子调用方法尽量是可直接拷贝运行的示例代码方便快速验证。写作规范推荐表格形式如果内容复杂可采用其他形式。调用方式支持 aclnn、图模式等方式调用算子请提供至少一种方式样例代码请在算子examples目录提供调用示例代码文件命名规则为test_${invoke_mode}_${op_name}说明针对不同调用方式提供补充介绍注意只要样例代码examples/cpp有变化请同步修改算子 README调用方式调用样例说明aclnn调用test_aclnn_{op_name}参见算子调用完成算子编译和验证。图模式调用test_geir_{op_name}参考资源可选[!NOTE]写作目标提供除算子功能、规格、调用外的其他补充介绍如算子设计文档Tiling/Kernel 设计、参考文献等。写作规范本章为可选若无参考资源可不呈现本章内容若有请采用无序列表形式。文档位置放在与 aclnn md 同层级目录下docs/xxx算子设计文档.md图片建议放在最外仓docs/zh/figures目录下算子设计原理【免费下载链接】cannbot-skillsCANNBot 是面向 CANN 开发的用于提升开发效率的系列智能体本仓库为其提供可复用的 Skills 模块。项目地址: https://gitcode.com/cann/cannbot-skills创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考