SuperAPI AI 工具集

external-gitcode-ascend-ascendc-operator-doc-gen

编程与开发

查看项目

更新于 10-15 17:19

技能介绍

用途:在 AscendC 算子编译调试通过后,从算子源码中提取接口信息,生成 PyTorch 官方文档风格的中文 API 接口文档(README.md)。触发场景包括“生成算子文档”“创建 README”“文档化算子”等。

主要能力:从 csrc/register.cpp 的 m.def 提取 Python 调用签名(含参数类型、默认值、返回类型,含 schema 到 Python 类型映射);从 csrc/ops.h 提取 C++ 函数声明;从 design.md 提取算法描述、参数语义、支持的 dtype、shape 约束与有效范围;从 op_host/<op_name>.cpp 的 TORCH_CHECK 提取运行时约束;从 tests/test_<op_name>.py 提炼可运行使用示例。随后按固定模板组装标题签名、功能描述(含 LaTeX 公式)、参数说明、支持的数据类型、Shape、约束条件、使用示例、返回值等段落,正文使用中文。

使用方式:工作流程分为信息提取、文档结构组装、文件生成、聊天界面展示四阶段。生成文件路径为 ascend-kernel/csrc/ops/<op_name>/README.md,已存在则覆盖,UTF-8 编码,公式用标准 LaTeX。文件生成后必须把完整内容输出到聊天界面并给出路径;信息不足处用 [TODO: ...] 标注。

限制:本技能是只读文档生成,不修改算子源码;所有信息必须从源码提取,不得编造参数或 dtype;不得跳过 TORCH_CHECK 约束提取;不得与 register.cpp schema 不一致;必须包含使用示例;正文须为中文(标题签名、代码、数学公式除外)。前置条件为编译测试已通过,且 register.cpp、ops.h、design.md、op_host 文件与测试文件均已就绪。

适用场景:AscendC 算子开发完成后需要规范化接口文档、便于他人调用与维护时使用。具体命令行用法与安装方式资料暂未提供。