Closed
[Documentation|文档反馈]: matmul 设计总结存在"待更新/待完善"遗留占位,Padding 抽象适用场景缺失 #594
廖氏如神Add on Sep 20Closed at Sep 21
sunhao_hw
Sep 21 Comments:
Sep 21 Comments:
感谢开发者的反馈,会尽快对文档进行修改。StreamK会补充库上已有的算法方案,Padding几种模式适用场景由于难以直接量化区分,将推荐开发者自行尝试,并去掉文档中的模糊描述


感谢开发者的反馈,会尽快对文档进行修改。StreamK会补充库上已有的算法方案,Padding几种模式适用场景由于难以直接量化区分,将推荐开发者自行尝试,并去掉文档中的模糊描述


问题描述
docs/zh/2_Design/01_kernel_design/04_matmul_summary.md中存在文档自述未完成的遗留占位:PaddingMatrixND、PaddingMatrixBlockND和PaddingMatrixNZ各自的适用场景待完善,泛化上PaddingMatrixNZ更具有优势。即:文档明确宣称部分内容"待更新 / 待完善",但长期未补齐(非近期改动引入)。
规范依据
《文档写作规范》要求文档内容完整、准确。设计文档中公开声明"待完善"且长期未跟进,会向读者传递"该文档内容可能不可信/不完整"的信号。
影响分析
PaddingMatrixND/PaddingMatrixBlockND/PaddingMatrixNZ是 Padding 前处理的三个核心抽象,文档自述"各自的适用场景待完善"——开发者无法据此判断选型,只能读源码;修复建议
问题复现方式
git clone --depth 1 https://gitcode.com/cann/catlass.git cd catlass sed -n '5p' docs/zh/2_Design/01_kernel_design/04_matmul_summary.md # "待更新" sed -n '608p' docs/zh/2_Design/01_kernel_design/04_matmul_summary.md # "待完善"影响级别
L2:设计文档关键选型信息缺失(文档自述待完善),影响开发者对 Padding 抽象的正确选用;不影响功能正确性。