Merged
docs(swiglu): 修正单轴和双轴量化文档的 cuBLAS 拼写 #14495
docs(swiglu): 修正单轴和双轴量化文档的 cuBLAS 拼写 #14495
Merged
liweijian16Add on 5 days ago
liweijian16
liweijian16Collaborators
5 days ago

描述

修正单轴、双轴 SwiGLU 量化文档中的算法名称拼写,共 6 份文档、23 处替换。

- CuBALS
+ cuBLAS

仅修正文档名称,不修改计算公式、算子代码或接口行为。

关联的Issue

Fixes #8637

https://gitcode.com/cann/ops-nn/issues/8637

测试

  • 修改前:相关文档包含 23 处 CuBALS。
  • 修改后:git grep -n -i cubals -- '*.md' '*.rst' 无匹配。
  • git diff --check 通过。
  • pre-commit 适用检查通过,包括 codespell 和 OAT(6 个文件)。
  • 纯文档修改,未运行算子编译和 NPU 测试。

文档更新

  • activation/swiglu_group_quant/:中英文 README、docs/aclnnSwigluGroupQuantV2.md。
  • activation/swiglu_group_quant_with_dual_axis/:中英文 README、docs/aclnnSwigluGroupQuantWithDualAxis.md。

类型标签

AI/Agent生成声明

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for liweijian16's contribution.)
liweijian16liweijian16Collaborators
5 days ago Created pull request, commit 703f5e7b
liweijian16liweijian16Collaborators
5 days ago Associated issue: [Documentation|文档反馈]: aclnnSwigluGroupQuantV2.md 文档存在 1 处问题需修正
atomgit-bot
atomgit-bot
5 days ago Comments:

变更摘要

本 PR 是一次纯文档修正,将单轴 swiglu_group_quant 与双轴 swiglu_group_quant_with_dual_axis 两个 SwiGLU 量化算子文档中误写的算法名 CuBALS 统一更正为 cuBLAS,涉及中英文 README 及接口文档共 6 份文档。改动仅限名称拼写,量化算法描述、计算公式、scale 计算规则、算子实现与接口行为均未变化。

主要改动

  • 算法命名统一:README.md、README_en.md、aclnnSwigluGroupQuantV2.md、aclnnSwigluGroupQuantWithDualAxis.md 中出现的 CuBALS 全部替换为 cuBLAS,与 CUDA 官方库名称保持一致。
  • quant_mode=5 特性说明修正:单轴算子文档中 MX Quant V2 的特性描述由 “变体 Clipped SwiGLU + CuBALS MX FP8 量化” 更正为 cuBLAS,中英文版本同步修改。
  • 量化公式段落修正:MX FP8 量化流程中的 “Amax 计算(无下限)”“指数向上取整” 等小节标题及 mxScale1[t, c] = \text{cuBLAS}(amax[t, c]) 公式中的函数名标注同步更新,保持公式语义不变。
  • 接口行为说明修正:aclnnSwigluGroupQuantV2 与双轴接口文档中 scale_alg=1/scaleAlg=1 的尺度算法描述改为固定 cuBLAS,保留 “无 amax 下限”“与双轴第 1 路共享同一 MX kernel” 等原有表述。
  • 文档结构不变:仅替换名称,未新增或删除章节,未修改算子接口参数、量化分组(固定 32 元素块)及数值一致性说明。

🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
atomgit-bot
atomgit-bot
5 days ago Comments:

代码审查

✅ 未发现问题


🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
5 days ago Added label: cann-cla/yes
CANN-robot
CANN-robotCollaborators
5 days ago Comments:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
*/*/README.md ✅ 陈娇, 上官秦南, 钱泽洪 (3/2) ✅ 陈娇 (1/1)
*/*/docs/acl*.md ✅ 陈娇, 上官秦南, 钱泽洪 (3/2) ✅ 陈娇 (1/1)
activation ✅ 钱泽洪, 上官秦南 (2/2) ✅ 钱泽洪 (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

liweijian16, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robotCollaborators
5 days ago Set zengjuan,u010470851,chaotang233,kevin_huang1234,crystalhu,yangyang016,fanqirui,gitee-duhuiping,wangrui_,renruhai,su-yueming,zhajianqing123,yourealize,chenqi317,wang-xing001,liubo75,tangweiwei2,gitcode-chenjiao,chenxingyu18,liujie12345678,east_yang,lwx1255555,pingchuantang,Chen_HaoWen,qianzehong,fengying555682,caiwenwen,yanglu-1 as approver
CANN-robotCANN-robotCollaborators
5 days ago Set u010470851,kevin_huang1234,gitee-duhuiping,wangrui_,renruhai,su-yueming,zhajianqing123,yourealize,wang-xing001,gitcode-chenjiao,chenxingyu18,liujie12345678,east_yang,lwx1255555,pingchuantang,Chen_HaoWen,qianzehong,fengying555682,caiwenwen,yanglu-1 as approver
liweijian16liweijian16Collaborators
5 days ago Modify description of pull request
liweijian16
liweijian16Collaborators
5 days ago Comments:

compile

likedislike
liweijian16liweijian16Collaborators
5 days ago Pre merge succeeded (commit_id: 0702ce79fa8e131167253c90187142097420d80c)
CANN-robot
CANN-robotCollaborators
5 days ago Comments:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robotCollaborators
5 days ago Added label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
5 days ago Removed label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
5 days ago Added label: ci-pipeline-passed
chenjiao
chenjiaoCollaborators
5 days ago Comments:

/approve

likedislike
yuning_chen
yuning_chenCollaborators
5 days ago Comments:
sgqt12
sgqt12Collaborators
5 days ago Comments:

/lgtm

likedislike
qianzehong
qianzehongCollaborators
5 days ago Comments:

/lgtm
/approve

likedislike
CANN-robotCANN-robotCollaborators
5 days ago Added label: lgtmapproved
5 event messages are collapsed here。 See more
liweijian16liweijian16Collaborators
2 days ago Associated issue: [Documentation|文档反馈]: aclnnSwigluGroupQuantWithDualAxis.md 文档存在 1 处问题需修正