已合并
补充 matmulCompress Readme文档 #6966
ww-blue创建于 7月3日
补充 matmulCompress Readme文档 #6966
已合并
ww-blue创建于 7月3日
ww-blue
ww-blue成员
7月3日

描述

补充 matmulCompress Readme文档

关联的Issue

关联Issue #3699

测试

文档更新

matmul/matmul_compress/README.md

类型标签

AI/Agent生成声明

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 ww-blue 的贡献)
ww-blueww-blue成员
7月3日 创建了 pull request,commit 08812b75
ww-blueww-blue成员
7月3日 关联了issue:[Bug-Report|缺陷反馈]: matmul_compress算子有kernel实现,但是缺少kernel算子的接口说明文档README.md
CANN-robotCANN-robot成员
7月3日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
7月3日 评论:

CLA Signature Pass

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

likedislike
CANN-robot
CANN-robot成员
7月3日 评论:

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


PR Approval Progress

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

Module Approval Details

module lgtm status approve status
*/*/README.md 吴瑶, 杨阳 (2/2) 吴瑶 (1/1)
** gcw_kUomxQ2l, 杨阳 (2/2) gcw_kUomxQ2l (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
ww-blue
ww-blue成员
7月3日 评论:

compile

likedislike
ww-blueww-blue成员
7月3日 update merge request[project id: 7665709, iid: 6966, commit_id: fcd53bc9b26a891d2fec925aea6904002da74002] virtual merging success
CANN-robotCANN-robot成员
7月3日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月3日 评论:

流水线任务触发成功
任务链接 [002a64d3d8ca449e8588842ad94b8d76][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86_mobile_station ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_experimental ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_950 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_950 ✅ SUCCESS >>>>> >>>>>
Compile_Pre ✅ SUCCESS >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
Compile_harmony-infer-chs-nn ✅ SUCCESS >>>>>
UT_Test_ophost ✅ SUCCESS
UT_Test_opapi ✅ SUCCESS
UT_Test_kernel ✅ SUCCESS
UT_Test_opgraph ✅ SUCCESS
PreSmoke_A900 ✅ SUCCESS >>>>>
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>

[2026-07-03 11:02:15]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月3日 评论:

流水线任务触发成功
任务链接 [9d576610127a46c2a4028e1f61648f8d][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_checkpr ✅ SUCCESS
StaticCheck_codespell_check ✅ SUCCESS
StaticCheck_link_validity_check ✅ SUCCESS
StaticCheck_resource_existence_check ✅ SUCCESS
StaticCheck_tag_closed_check ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_style ✅ SUCCESS >>>>>
codecheck_precommit ⚠️ WARNING >>>>> >>>>>
SCA ✅ SUCCESS >>>>>

[2026-07-03 10:57:50]    CI执行结束

likedislike
CANN-robotCANN-robot成员
7月3日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月3日 添加了label:ci-pipeline-passed
atomgit-bot
atomgit-bot
7月3日 评论:

变更摘要

该 PR 为 matmulCompress 模块补充了 README 文档,属于纯文档更新。新增文档位于 matmul/matmul_compress/README.md,共添加 85 行内容,无删除行。此变更为关联 Issue #3699 的文档完善工作。

主要改动

  • 新增 matmul/matmul_compress/README.md 文档:为 matmulCompress 模块补充了 85 行的 README 说明文档,包含模块功能描述、使用方式等相关内容,提升模块的可读性和可用性。
likedislike
atomgit-bot
atomgit-bot
7月3日 评论:

代码审查

审查总结

我已完成对 matmul/matmul_compress/README.md 变更的审查。该文件是一个新增的算子接口说明文档(+85 行),对应 Issue #3699。

文件 审查结果
matmul/matmul_compress/README.md 发现 2 个问题

发现问题统计

优先级 数量 说明
P0 0
P1 1 x2 参数数据类型 FLOAT16 应为 INT8,用户按文档传参会触发运行时校验失败
P2 1 "所有输入张量不支持非连续Tensor" 与实际代码行为和详细 API 文档矛盾
P3 0

整体风险评估

中等风险。P1 发现会导致用户按照 README 传入 FLOAT16 类型的 x2 时直接命中 ACLNN_ERR_PARAM_INVALID 错误,算子调用失败。P2 发现会误导用户对非连续 Tensor 的支持情况产生错误理解。两个问题均需要在合入前修正。

类型 数量
🔴 阻塞 1
🟡 建议 1

⛔ 需要修改

likedislike
atomgit-bot
atomgit-bot7月3日进行代码检视2
matmul/matmul_compress/README.md
@@ -0,0 +52,4 @@
52+ <td>x2</td>
53+ <td>输入张量</td>
54+ <td>压缩后的矩阵乘右输入,1维张量。</td>
55+ <td>FLOAT16</td>
atomgit-bot
atomgit-bot7月3日评论:

🟠 High Priority

README 第 55 行将 x2(压缩后的右矩阵数据)的数据类型标注为 FLOAT16,但代码实现中 x2 的数据类型在所有层级均被定义为 INT8:

  1. matmul_compress_def.cpp 第 31 行:Input("B") 定义为 DataType({ge::DT_INT8})
  2. aclnn_matmul_compress.cpp 第 26 行:X2_DTYPE_SUPPORT_LIST = {DataType::DT_INT8},运行时校验 weight 必须为 INT8
  3. matmul_compress.h 第 70 行:kernel 中 gm_b.SetGlobalBuffer(reinterpret_cast<__gm__ int8_t *>(B)),将 B 解释为 int8_t 指针
  4. matmul_compress.h 第 385 行:AscendC::GlobalTensor<int8_t> gm_b 声明

失效模式:用户按照 README 传入 FLOAT16 类型的 x2,将在 CheckDtypeValid 校验时命中 ACLNN_ERR_PARAM_INVALID(错误码 161002),算子调用直接失败。压缩后的数据本质上是一维字节流,INT8 是正确的数据类型。

建议:将 x2 行(第 54-56 行)的数据类型从 FLOAT16 改为 INT8。建议同步检查详细接口文档 docs/aclnnMatmulCompress.md 中 weight 参数的数据类型(第 90 行也存在同样的问题)。

likedislike
ww-blue
ww-blue成员
7月3日 评论:

输入压缩工具前为fp16

atomgit-bot
atomgit-bot7月3日进行代码检视2
matmul/matmul_compress/README.md
@@ -0,0 +81,4 @@
81+## 约束说明
82+ 
83+- x1和x2_unzip的Reduce维度大小必须相等。
84+- 所有输入张量不支持非连续的Tensor。
atomgit-bot
atomgit-bot7月3日评论:

🟡 Medium Priority

README 第 84 行声明"所有输入张量不支持非连续的Tensor",但该约束与实际代码行为和详细 API 文档均矛盾:

  1. matmul_compress_def.cpp 第 28-46 行:所有输入(A/B/bias/compress_index)均调用了 .AutoContiguous(),GE 框架会自动将非连续 Tensor 转为连续后再传给算子
  2. aclnn_matmul_compress.cpp 第 143 行:bias = l0op::Contiguous(bias, uniqueExecutor.get()) — API 实现层显式处理 bias 的连续性转换
  3. aclnn_matmul_compress.cpp 第 156 行注释明确写道:"out可能是非连续的tensor"
  4. 详细 API 文档 aclnnMatmulCompress.md 第 83/93/103/113 行:"非连续tensor" 列对 x/weight/bias/compressIndex 均标注为 √(支持)

失效模式:用户可能被误导,在调用前进行不必要的手动连续性转换,增加额外开发工作和性能开销。更严重的是,用户看到该约束后可能认为非连续 Tensor 完全不可用,从而对输入数据的组织方式产生错误理解。

建议:将第 84 行改为与详细 API 文档一致的说明:所有输入张量均支持非连续 Tensor(框架通过 AutoContiguous 机制自动处理连续性转换)。或直接删除该行,因为这是框架自动处理的细节,对用户并非硬性约束。

likedislike
ww-blue
ww-blue成员
7月3日 评论:

非问题

ww-blueww-blue成员
7月3日 update merge request[project id: 7665709, iid: 6966, commit_id: fdc7303ab0850f257a9d23208cc0067ff10540d3] virtual merging success
ww-blueww-blue成员
7月3日 强制推送  1 个提交:8fd2c615-补充 matmulCompress Readme文档
ww-blueww-blue成员
7月3日 update merge request[project id: 7665709, iid: 6966, commit_id: 59bb29fd8de2700843b30634cae1c1c3e900a26b] virtual merging success
CANN-robotCANN-robot成员
7月3日 删除了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
7月3日 评论:

Notification

This pull request has been changed(code update) or closed, so removes the following label(s): ci-pipeline-passed.

likedislike
ww-blueww-blue成员
7月3日 解决了最后一个问题
ww-blue
ww-blue成员
7月3日 评论:

compile

likedislike
ww-blueww-blue成员
7月3日 update merge request[project id: 7665709, iid: 6966, commit_id: 159594fac6ed91b41eefb87b40a100e56737f402] virtual merging success
CANN-robotCANN-robot成员
7月3日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月3日 评论:

流水线任务触发成功
任务链接 [cd1fd464f7564117a9b57599d1da6145][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86_mobile_station ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_single ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_experimental ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_950 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_950 ✅ SUCCESS >>>>> >>>>>
Compile_Pre ✅ SUCCESS >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
Compile_harmony-infer-chs-nn ✅ SUCCESS >>>>>
UT_Test_ophost ✅ SUCCESS
UT_Test_opapi ✅ SUCCESS
UT_Test_kernel ✅ SUCCESS
UT_Test_opgraph ✅ SUCCESS
PreSmoke_A900 ✅ SUCCESS >>>>>
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>

[2026-07-03 11:38:14]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月3日 评论:

流水线任务触发成功
任务链接 [e6697a26108e47d39d4cb7812acab5b1][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_checkpr ✅ SUCCESS
StaticCheck_codespell_check ✅ SUCCESS
StaticCheck_link_validity_check ✅ SUCCESS
StaticCheck_resource_existence_check ✅ SUCCESS
StaticCheck_tag_closed_check ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_style ✅ SUCCESS >>>>>
codecheck_precommit ⚠️ WARNING >>>>> >>>>>
SCA ✅ SUCCESS >>>>>

[2026-07-03 11:31:41]    CI执行结束

likedislike
CANN-robotCANN-robot成员
7月3日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月3日 添加了label:ci-pipeline-passed
吴瑶成员
7月3日 评论:

/approve

likedislike
liulun0308成员
7月3日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
7月3日 添加了label:approved
唐超成员
7月3日 评论:

/lgtm
/approve

likedislike
CANN-robot
CANN-robot成员
7月3日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
唐超

likedislike
CANN-robot
CANN-robot成员
7月3日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
唐超

likedislike
yangyang016成员
7月3日 评论:

/lgtm
/approve

likedislike
CANN-robot
CANN-robot成员
7月3日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
唐超

likedislike
CANN-robotCANN-robot成员
7月3日 添加了label:lgtm
CANN-robotCANN-robot成员
7月3日 合入了pull request
CANN-robot
CANN-robot成员
7月3日 评论:

Pull Request 已合并或已关闭。

If you want to solve this problem, you can click here to do it in the FAQs.

likedislike