已关闭
[Requirement|需求建议]: 建议补充 ops-transformer 算子支持矩阵与快速检索索引 #3586
安琪Angel_创建于  7月4日关闭于  16 天前
安琪Angel_
安琪Angel_
7月4日 创建

Thanks for sending an requirement! Please fill in the following template to help quickly solve your problem.

Backgroud(背景信息)

当前 ops-transformer 仓库包含多个 transformer 类大模型相关算子,适用于在 NPU 上进行加速计算。对于初次使用该仓库的开发者来说,通常需要根据模型结构或算子名称,在不同目录中逐个查找 README、接口说明、样例和支持范围信息。
在实际学习和使用过程中,我发现如果想快速确认某个算子是否支持特定芯片、数据类型、输入 shape 或接口形式,需要进入多个目录分别查看文档,检索成本较高。尤其是新开发者在选择算子、定位样例、确认使用条件时,容易花费较多时间。
因此建议在仓库文档中补充一个统一的“算子支持矩阵与快速检索索引”,用于汇总常用算子的关键信息。

Benefit / Necessity (价值/作用)

增加统一的算子支持矩阵与快速检索索引后,可以带来以下收益:

  1. 降低新开发者使用 ops-transformer 的上手成本,便于快速了解仓库中已有算子能力。
  2. 提升算子检索效率,开发者可以通过一个入口快速定位目标算子的文档、样例和目录。
  3. 便于确认不同算子的支持范围,例如支持芯片、数据类型、输入输出约束、是否有样例等。
  4. 有助于减少重复 Issue 或使用咨询,提升社区协作效率。
  5. 对参与 CANN 社区贡献的开发者也更友好,后续可以围绕文档完善、样例补充、算子支持范围说明等方向继续贡献。

Design(设计方案)

建议在仓库 docs 或 README 中新增一个算子索引文档,例如:

  • docs/zh/op_support_matrix.md
  • 或在 README.md 中增加“算子快速索引”章节
    建议表格字段如下:
    | 算子名称 | 所属目录 | 功能简介 | 支持芯片/架构 | 支持数据类型 | 是否提供样例 | 文档链接 |
    | --- | --- | --- | --- | --- | --- | --- |
    | FlashAttentionScore | attention/... | 注意力计算相关算子 | 按实际文档填写 | fp16/bf16 等,按实际支持填写 | 是/否 | README 链接 |
    | FusedInferAttentionScore | attention/... | 推理场景注意力相关算子 | 按实际文档填写 | 按实际支持填写 | 是/否 | README 链接 |
    | GroupedMatMul | ... | 分组矩阵乘相关算子 | 按实际文档填写 | 按实际支持填写 | 是/否 | README 链接 |
    实现思路:
  1. 先整理仓库中已有算子目录和 README 文档。
  2. 提取每个算子的名称、功能简介、支持范围、样例入口等信息。
  3. 在 docs/zh 下新增统一索引文档,并在仓库 README 中增加跳转链接。
  4. 后续新增算子时,同步维护该索引,保证文档入口统一。
  5. 如社区已有类似文档,也可以在现有文档基础上补充“支持矩阵”和“快速跳转链接”。
likedislike
Wweihao18成员
7月6日 添加了label:feature
weihao18成员
7月6日 评论:

/assign @wang-minbo

likedislike
CANN-robotCANN-robot成员
7月6日 将 wang-minbo 设为负责人
wang-minbo成员
7月6日 评论:

您好,已收到您的诉求,后天我们将在sig上评审该需求

likedislike
wang-minbo成员
8月31日 评论:

这个需求将于9月交付

likedislike
Llixiawei成员
16 天前 关联了pull request:README中添加算子索引链接
CANN-robotCANN-robot成员
16 天前 关闭了 issue
CANN-robotCANN-robot成员
16 天前 添加了label:resolved