已合并
[Doc] 新增量化模式术语词条与量化模式详档 #818
[Doc] 新增量化模式术语词条与量化模式详档 #818
已合并
rookie_hongchuan创建于 25 天前
rookie_hongchuan成员
25 天前

PR 提交说明

1. 影响面评估

接口变更(按需):

备注:无 CLI/API/YAML 变更,纯文档新增。

输出件变更(按需):

备注:无导出格式、产物路径变更。

非兼容变更(按需):

SIG 评审结论(按需):

2. 修改描述

修改背景(可选): knowledge_base 下尚无「量化模式」分类:初学者缺少理解"量化为何能加速"的入门词条,具体量化模式也缺少规范详档。本次按 docs_standards 词条模板(01_term_glossary_template)补齐该域。

修改目的: 建立「量化模式」术语词条与 16 个模式详档,对齐 msModelSlim 实际 IR 实现(线性层 / KVCache / FA 三类),并在知识库索引注册新目录。

修改内容:(按「概念 - 变化」分条)

  • docs:新增「量化基础」词条域 docs/zh/knowledge_base/quantization_basic/(7 个文件:README 索引 + 6 个数据类型/概念词条 term_*.md,覆盖 INT8/INT4/FP8/FP16/BF16/MXFP8/量化与反量化)
  • docs:新增「量化模式」词条域 docs/zh/knowledge_base/quantization_mode/(21 个文件:README + 线性层/KVCache/FA 三类子目录词条),对齐 msmodelslim/ir/ 实际 IR 实现(W8A8/W4A4/W8A16 等 12 个线性层模式、KVCache-PerChannel、FA PerBlock/PerHead/PerToken、GEMM 词条)
  • docs:knowledge_base/README.md 注册 quantization_basicquantization_mode 两个新目录索引,并修正 ptq 目录引用指向(上游 PTQ 重构后 usage.md 更名为 usage_weight_conversion.md
  • docs:参考文档章节移除与词条主题不匹配的论文引用(Jacob INT8 / ZeroQuant / KIVI / Rouhani MX),保留主题直接相关的 4 篇(GPTQ / BF16 / FP8 / FlashAttention);quantization_mode/README.md 保留原始参考资料

3. 功能验证

复现步骤(可选):

# 1) 无模板占位(双花括号)、无禁词:应无输出
grep -rEn '\{\{' docs/zh/knowledge_base/quantization_mode/ docs/zh/knowledge_base/quantization_basic/
grep -rEn '待补充|TODO|FIXME|TBD' docs/zh/knowledge_base/quantization_mode/ docs/zh/knowledge_base/quantization_basic/

# 2) 本 PR 涉及的全部 .md 文件相对链接可解析
python3 - <<'EOF'
import os, re, subprocess
files=[f for f in subprocess.check_output(
    ['git','diff','upstream/master','HEAD','--name-only']).decode().splitlines() if f.endswith('.md')]
bad=[]
for f in files:
    src=open(f, encoding='utf-8').read()
    for m in re.findall(r'\[[^\]]*\]\(([^)#]+)(?:#[^)]*)?\)', src):
        if m.startswith(('http','#','mailto:')): continue
        p=os.path.normpath(os.path.join(os.path.dirname(f), m))
        if not os.path.exists(p): bad.append((f,m))
print('broken links in PR files:', bad if bad else 'none')
EOF

4. 自检(请逐项确认,不适用标 N/A)

典型安全编码问题

DT

5. docs_standards 校验清单检查结果

按最新《量化术语百科校验清单》(docs_standards/01_term_glossary_checklist.md,2026-08-13 更新版)对 PR 涉及的 28 个文件(23 个 term_*.md 词条 + 5 个 README 类别/索引文档)执行逐项检查。

总体结论:通过(无 ERROR 阻断项)

  • ERROR 级:25/25 通过(术语清单 19 项 + 公共清单 6 项)
    • G01 文件命名、S01 必填章节、S03 章节顺序、S05 信息框字段、S06 词条类别取值(已按枚举集合修正:量化基础概念 ×6、量化数据格式 ×20,均带上层链接)、S11 标题分隔符
    • L01/L02/L03 关联词条、L05 概述超链接、C01/C02 概述、C08 知识类型、C10 无占位残留、R01 链接一致性、K02 待建词条登记、K04 词条唯一性
    • CE-01~CE-06 公共条目(无模板占位/敏感信息、单 H1、书名号规范等)
  • WARN 级:10/14 满足,4 项建议项(非阻断):
    • L10 锚文本:词条类别上层链接解析到父级目录索引(设计取舍,可加 waiver 说明)
    • C07 参考文档字段:4 处 arXiv 文献缺显式年份
    • G02 文件编码:UTF-8 无 BOM(既有量化算法文档带 BOM,全仓口径待统一)
    • C06 参考文档数量:模式词条参考偏薄,可按原始出处补强
  • 知识图谱:K01 反向引用 23/23 词条入度 ≥1;K03 弱连通图成立(basic↔mode 经 term_gemm/term_int8 等桥接)

注:第一轮检查发现的 S06 ERROR(词条类别取值不在枚举集合内)已在本 PR 修复,第二轮复核确认通过。

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 rookie_hongchuan 的贡献)
atomgit-bot
atomgit-bot
25 天前 评论:

变更摘要

本次 PR 为 knowledge_base 新增「量化模式」文档域,包含术语词条与 16 个模式详档,对齐 msmodelslim/ir/ 的线性层 / KVCache / FA 三类 IR 实现,并在 mkdocs.yml 中注册导航,同时对原有章节编号进行顺延调整。

主要改动

  • 新增「四、量化模式」导航节:在 mkdocs.ymlnav 配置中插入「四、量化模式」顶级节点,下设术语介绍、线性层量化模式(12 项)、KVCache 量化模式(1 项)、FA 量化模式(3 项)三个子分组,覆盖全部 16 个模式词条。
  • 原章节编号顺延重排:由于插入新章节,mkdocs.yml 中原「四、量化格式」至「九、附录」依次重编号为「五」至「十」,共涉及 6 个顶级导航节点(+27 行新增,-6 行删除)。
  • 新增量化模式术语词条docs/zh/knowledge_base/quantization_mode/README.md 以线性层 / KVCache / FA 三类量化模式讲解性能收益,包含对称/非对称数学描述、mermaid 流程图及 16 模式索引。
  • 新增 16 个模式详档:其中 6 个精写文档(w8a8_static.mdw8a8_dynamic.mdw4a4_dynamic.mdkv_cache_perchannel.mdfa_perhead.mdfa_pertoken.md)承载 IR 类、分发表及 YAML 配置说明,其余 10 个为标注"规划中"的占位词条。
  • 相关索引文件同步更新knowledge_base/README.mdquantization_format/README.mddocs_standards/README.md 同步注册或改指「量化模式」分类入口。
likedislike
atomgit-bot
atomgit-bot
25 天前 评论:

代码审查

✅ 未发现问题

likedislike
rookie_hongchuan成员
25 天前 评论:

compile

likedislike
ascend-robotascend-robot成员
25 天前 添加了label:ascend-cla/yes
此处折叠了430条消息 查看更多
Rrookie_hongchuan成员
22 天前 关联了里程碑:MindStudio 26.2.0
ascend-robotascend-robot成员
22 天前 合入了pull request
ascend-robot
ascend-robot成员
22 天前 评论:

Pull Request 已合并或已关闭。

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

likedislike
ascend-robot
ascend-robot成员
22 天前 评论:

Pull Request 已合并或已关闭。

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

likedislike
ascend-robot
ascend-robot成员
22 天前 评论:

Pull Request 已合并或已关闭。

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

likedislike