mcpField
T
triton-operator-doc-gen

triton-operator-doc-gen

github.com/ascend文档处理52109 次安装25 周前更新
代码仓库

关于 triton-operator-doc-gen

用于生成 Triton 算子接口文档的技能,面向编写和维护算子文档的开发者。它要求依据模板、示例和 kernel 实现核对公式、平台支持、数据类型约束及可执行示例。

主要功能

  1. 01按模板组织接口文档
  2. 02编写功能说明与 LaTeX 公式
  3. 03整理平台支持和数据类型约束
  4. 04生成完整调用示例

适用场景

  1. 01为 Triton 算子编写接口文档
  2. 02核对文档公式与 kernel 实现
  3. 03补齐平台及 dtype 支持信息

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/ascend/agent-skills --skill triton-operator-doc-gen

安装后在 Claude Code 中输入/triton-operator-doc-gen确认已加载。

附带文件examples/layer-norm.mdreferences/triton_operator_template.md

详细介绍

来自项目 README

Triton 算子接口文档生成

工作流

  1. 收集算子信息:名称、功能、公式、接口、参数、约束
  2. MANDATORY:完整阅读 triton_operator_template.md 获取输出格式
  3. 参考示例:完整阅读 layer-norm.md 理解完整文档结构
  4. 需要确认 API 签名时,完整阅读 triton-api-reference.md
  5. 按模板生成文档,确保包含:
    • 产品支持情况表(Ascend 全系列产品)
    • 功能说明 + LaTeX 公式
    • 函数原型
    • 参数说明表
    • 约束条件(各平台数据类型支持)
    • 调用示例

常见陷阱

陷阱症状解决
产品支持表不全文档缺平台行覆盖所有 Ascend 产品线(A3/A2/950/Kirin)
约束表缺少 dtype 组合用户按文档用不支持的类型从 code 的 BLOCK_SIZE/dtype 限制反推,列出所有合法组合
公式与实现不一致文档说的和代码算的不一样从 kernel 代码逐行验证公式
调用示例不可运行用户复制粘贴报错示例必须完整可执行,包含 import 和数据构造

反模式清单(NEVER)

  • ❌ 生成空模板占位符(如 {公式}、{参数描述} 未填写)——所有占位符必须替换为实际内容
  • ❌ 调用示例缺少 import 语句或数据构造
  • ❌ 约束表缺少 dtype × 平台组合
  • ❌ 函数原型与实际 kernel 签名不一致
  • ❌ 公式使用纯文本而非 LaTeX 语法
  • ❌ 产品支持表包含不支持的型号标记为 √

评论

支持 Markdown