SuperAPI AI 工具集

ascendc-operator-doc-gen

通用与其它

查看项目

更新于 10-15 19:58

技能介绍

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

前置条件:编译测试通过,且以下文件就绪:csrc/register.cpp(m.def 注册的 Python 调用 schema)、csrc/ops.h(C++ 函数声明)、csrc/ops/<op_name>/design.md(算法描述、参数说明、dtype 支持、约束条件)、csrc/ops/<op_name>/op_host/<op_name>.cpp(TORCH_CHECK 约束与参数处理逻辑)、tests/test_<op_name>.py(可运行调用示例)。

主要能力:工作流程为信息提取、文档结构组装、文件生成、聊天界面展示。信息提取阶段逐一读取上述文件,从 register.cpp 提取 Python 调用签名并做 schema 到 Python 类型映射,从 ops.h 提取 C++ 签名,从 design.md 提取算法与设计信息,从 op_host 提取 TORCH_CHECK 运行时约束,从测试文件提取最简调用示例。文档按固定模板组装,包含标题签名、功能描述、参数说明、支持的数据类型、Shape、约束条件、使用示例、返回值等段落,正文使用中文,数学公式用 LaTeX。

使用方式:生成后写入 ascend-kernel/csrc/ops/<op_name>/README.md,已存在则覆盖,使用 UTF-8 编码;随后必须将完整 README.md 内容输出到聊天界面并给出文件路径。信息不足处用 [TODO: ...] 标注提醒补充。

限制:本技能为只读文档生成,不修改算子源代码;不得编造参数或 dtype,所有信息须从源代码提取;不得跳过 TORCH_CHECK 约束提取;参数名与类型须与 register.cpp schema 一致;不得省略使用示例;不得仅输出文件路径而不展示完整文档;正文除标题签名、代码、数学公式外不使用英文。具体安装命令与收费信息暂未提供。