人工智能深度学习算子库CANNAscend【免费下载链接】asc-devkit本项目是CANN 推出的昇腾AI处理器专用的算子程序开发语言原生支持C和C标准规范主要由类库和语言扩展层构成提供多层级API满足多维场景算子开发诉求。项目地址https://gitcode.com/cann/asc-devkit点击查看免费下载导读在 CANN asc-devkit 算子开发体系中算子原型Operator Prototype是框架识别、编译与执行算子的核心契约它以继承自OpDef的 C 类承载输入、输出、属性、Tiling 关联等全部声明。本文聚焦OpDef的Comment接口讲解如何在算子原型定义阶段设置算子分组信息与算子原型注释算子简述、约束、相关算子、第三方算子参考等使其在自动生成算子原型头文件时同步生成注释从而支撑构图、图编译、图执行及算子原型文档的自动化产出。读完本文你将掌握CommentSection全部取值语义、Comment的链式调用写法、与OpAttrDef::Comment、OpParamDef::Comment的配套用法以及 CATEGORY 分组带来的文件名过长约束与规避方法。Comment 接口在算子原型定义中的定位原型注册链路从 OpDef 类到 OP_ADD在 asc-devkit 中算子原型通过自定义算子类承载该类继承自OpDef构造函数内依次完成Input、Output、Attr、AICore().SetTiling(...)等声明文件末尾通过OP_ADD(opType)注册算子类型。编译工具据此识别算子原型并自动生成 aclnn 接口、图模式原型等相关代码参见 算子原型定义 与 OP_ADD。OpDef::Comment正是这条链路中的注释登记环节它设置的算子分组信息与注释内容会随原型定义一起被编译工具捕获在自动生成图模式场景使用的算子原型头文件时同步生成对应的注释帮助开发者理解算子原型并可基于这些注释自动生成算子原型的文档说明。Comment 接口的适用场景基于OpDef算子原型定义自定义算子工程可以实现如下自动化能力自动生成图模式场景使用的算子原型头文件开发者可以使用生成的算子原型进行构图、图编译、图执行等操作生成的注释辅助理解算子原型并可基于注释自动生成算子原型文档。通常情况下内置 CANN 算子使用较多开发者可以按需使用。函数原型与参数说明函数原型OpDef Comment(CommentSection section, const char *comment)Comment是OpDef的成员接口返回OpDef 引用因此可以与其他原型声明接口如Input、Output、Attr、AICore进行链式调用。参数 sectionCommentSection 枚举取值第一个参数section通过CommentSection类指定该接口注释的功能类型支持以下取值section 取值含义对应生成的注释CATEGORYcomment 内容设置的是算子分组名称分组名会对应生成同名代码文件用于算子归类BRIEFcomment 内容设置的是算子brief注释内容即算子功能的简述brief注释CONSTRAINTScomment 内容设置的是算子Attention Constraints注释内容即该算子的约束Attention Constraints注释RESTRICTIONScomment 内容设置的是算子Restrictions注释内容Restrictions注释该选项当前属于试验参数不推荐使用SEEcomment 内容设置的是算子see注释内容可以表示该算子的相关算子see注释THIRDPARTYFWKCOMPATcomment 内容设置的是算子参考的第三方算子第三方算子兼容性参考注释其中BRIEF、CONSTRAINTS、SEE是日常算子原型注释最常用的三个类型简述说明算子功能约束说明使用前提与限制SEE 建立与相关算子之间的引用关系。RESTRICTIONS属于试验参数当前不推荐使用。参数 comment第二个参数comment为const char *字符串即要增加的注释内容。同一 section 可以多次调用Comment追加多条注释见下文调用示例。返回值链式调用基石Comment返回OpDef算子定义本身OpDef 类型说明与完整定义请参考 OpDef。正是因为返回OpDef 可以在一条链式表达式中连续声明多个 section 的注释也可以与Input、Output等接口交替书写保持原型定义的紧凑与可读性。完整调用示例以下示例完整继承了原文档的调用样例并补充了行内注释说明每种 section 的作用class AddCustomComment : public OpDef { public: AddCustomComment(const char* name) : OpDef(name) { // 算子分组CATEGORY 会生成同名的原型定义代码文件 this-Comment(CommentSection::CATEGORY, catg); // BRIEF 注释算子功能简述 this-Comment(CommentSection::BRIEF, Brief cmt) // BRIEF注释 // CONSTRAINTS 注释算子约束可多次追加 .Comment(CommentSection::CONSTRAINTS, Constraints cmt1) // CONSTRAINTS注释 .Comment(CommentSection::CONSTRAINTS, Constraints cmt2); // RESTRICTIONS 注释试验参数不推荐使用可多次追加 this-Comment(CommentSection::RESTRICTIONS, Restrictions cmt1) // RESTRICTIONS注释 .Comment(CommentSection::RESTRICTIONS, Restrictions cmt2) // THIRDPARTYFWKCOMPAT 注释参考的第三方算子可多次追加 .Comment(CommentSection::THIRDPARTYFWKCOMPAT, Third-party framework compatibility cmt1) // THIRDPARTYFWKCOMPAT注释 .Comment(CommentSection::THIRDPARTYFWKCOMPAT, Third-party framework compatibility cmt2) // SEE 注释相关算子可多次追加 .Comment(CommentSection::SEE, See cmt1) // SEE注释 .Comment(CommentSection::SEE, See cmt2); // 输入 x必选参数支持 DT_FLOAT / DT_INT32FORMAT_ND this-Input(x) .ParamType(REQUIRED) .DataType({ge::DT_FLOAT, ge::DT_INT32}) .FormatList({ge::FORMAT_ND}); // 输入 y必选参数支持 DT_FLOAT / DT_INT32FORMAT_ND this-Input(y) .ParamType(REQUIRED) .DataType({ge::DT_FLOAT, ge::DT_INT32}) .FormatList({ge::FORMAT_ND}); // 输出 z必选参数支持 DT_FLOAT / DT_INT32FORMAT_ND this-Output(z) .ParamType(REQUIRED) .DataType({ge::DT_FLOAT, ge::DT_INT32}) .FormatList({ge::FORMAT_ND}); // 关联 Host 侧 Tiling 函数 this-AICore() .SetTiling(optiling::TilingFunc); // 配置指定 AI 处理器的差异化编译配置 this-AICore().AddConfig(ascendxxx); } };要点归纳同一 section 可多次调用CONSTRAINTS、RESTRICTIONS、THIRDPARTYFWKCOMPAT、SEE在示例中都连续追加了两次生成时对应注释会保留多条内容分组名与注释独立设置CATEGORY的分组名示例中的catg与BRIEF等功能注释相互独立可在不同语句中分别设置与原型声明共存Comment可以与Input/Output/AICore等声明写在同一个构造函数中最终统一参与原型头文件的自动生成。约束说明CATEGORY 分组与文件名过长问题约束机制当用户使用CATEGORY参数设置算子分组名称时编译工具会对应生成同名的代码文件供 GE 调用的原型定义代码文件。若该文件名过长在编译时可能超过 tar 打包的文件名称长度限制导致报错。具体报错形态可参考 算子工程编译时出现文件名过长报错典型错误信息如下tar: ./packages/vendors/customize/op_proto/inc/my_very_long_and_detailed_c_plus_plus_project_source_code_file_containing_advanced_features_and_implementations.h: file name is too long (cannot be split); not dumped或tar: ./packages/vendors/ProjectX_FeatureY_Z_.../op_impl/ai_core/tbe/.../dynamic/add_custom.cpp: file name is too long (max 256); not dumped规避方法出现此类报错时应根据报错信息定位超长文件名并减少对应文件名或路径长度若超长文件是使用Comment接口设置算子分组名称后生成的同名原型定义代码文件应减少算子分组名称的长度若超长文件是op_kernel目录下的核函数侧代码或op_host目录下的 host 侧代码文件名由创建算子工程时传入的算子 OpType 自动生成应减少OpType 的长度若报错由路径过长引起如在CMakePresets.json中配置vendor_name导致 vendor 目录路径超长应减少配置的vendor_name长度。因此在使用CommentSection::CATEGORY设置算子分组名称时建议遵循短而有意义的命名原则避免使用超长字符串作为分组名。与 OpAttrDef::Comment、OpParamDef::Comment 的配套使用OpDef::Comment负责算子级注释而算子原型中的属性与输入输出参数还有各自独立的注释接口三者配合可让生成的算子原型头文件注释体系完整接口作用对象函数原型参考文档OpDef::Comment算子分组与算子级注释简述、约束、相关算子等OpDef Comment(CommentSection section, const char *comment)本文及 OpDefOpAttrDef::Comment算子属性注释OpAttrDef Comment(const char *comment)OpAttrDef/CommentOpParamDef::Comment输入/输出参数注释OpParamDef Comment(const char *comment)OpParamDef/Comment例如为属性添加注释可写作this-Attr(attrname).Comment(Attr cmt 1);为输入输出添加注释可写作this-Input(x) .ParamType(REQUIRED) .DataType({ge::DT_FLOAT, ge::DT_INT32}) .FormatList({ge::FORMAT_ND}) .Comment(Input cmt 1); // 注释内容这些接口的返回值类型分别为OpAttrDef 与OpParamDef 同样支持在各自定义链上自由穿插。自动生成链路中的实际效果从 算子原型定义 可知算子原型定义文件位于算子工程 Host 侧如op_host/add_custom.cpp其中同时包含TilingFunc、图模式的InferShape/InferDataType推导函数以及继承自OpDef的算子原型类。原型类完成定义后通过OP_ADD(AddCustom)注册算子类型编译工具据此识别算子原型并生成 aclnn 接口、图模式原型等代码。Comment接口设置的注释正是在这一自动生成过程中被同步写入生成的原型头文件briefBRIEF生成头文件中算子功能的简述Attention ConstraintsCONSTRAINTS生成头文件中算子的使用约束seeSEE生成头文件中指向相关算子的引用CATEGORY生成同名的原型定义代码文件作为算子分组归档依据。由此自定义算子工程可以获得与内置 CANN 算子一致的原型注释体验开发者可直接阅读生成的算子原型头文件理解算子语义也可以基于这些注释自动生成算子原型的文档说明减少人工维护文档的成本。小结OpDef::Comment是 asc-devkit 算子原型定义中注释即资产理念的具体落地通过CommentSection区分分组、简述、约束、相关算子与第三方算子参考在自动生成算子原型头文件时同步产出结构化注释。使用时注意两点RESTRICTIONS为试验参数不推荐使用CATEGORY分组名会生成同名代码文件命名应保持精简以避免触发 tar 文件名过长报错。如需为属性或输入输出单独添加注释可分别使用OpAttrDef::Comment与OpParamDef::Comment三者共同构成完整的算子原型注释体系。延伸阅读原型注册与管理原型注册接口全览OP_ADD算子原型注册接口说明OpDefOpDef类全部成员接口算子原型定义原型定义在算子工程中的实际组织方式算子工程编译时出现文件名过长报错CATEGORY 分组名过长时的完整定位与解决步骤。赞分享人工智能深度学习算子库CANNAscend【免费下载链接】asc-devkit本项目是CANN 推出的昇腾AI处理器专用的算子程序开发语言原生支持C和C标准规范主要由类库和语言扩展层构成提供多层级API满足多维场景算子开发诉求。项目地址https://gitcode.com/cann/asc-devkit点击查看免费下载相关推荐asc-devkit 算子原型注册系列OpAttrDef::Comment 接口详解——为算子属性添加注释并自动生成算子原型头文件asc devkit 算子原型注册系列OpAttrDef::Comment 接口详解——为算子属性添加注释并自动生成算子原型头文件 导读 OpAttrDef:人工智能深度学习算子库CANNAscendasc-devkit 算子原型注册详解OpDef::AICore() 接口配置 AI Core 算子执行信息asc devkit 算子原型注册详解OpDef::AICore 接口配置 AI Core 算子执行信息 本文面向在 CANN asc devkit 开源仓库人工智能深度学习算子库CANNAscendasc-devkit 算子原型开发OpParamDef::Comment 参数注释接口实战解析asc devkit 算子原型开发OpParamDef::Comment 参数注释接口实战解析 导读 在 CANN asc devkit 的算子原型注册体系中人工智能深度学习算子库CANNAscend上一篇FazJammer法律与伦理指南了解无线干扰的合法边界下一篇终极指南如何通过wasm-bindgen代码生成优化大幅减少JavaScript桥接代码创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
