| [Doc] 新增量化模式术语词条与量化模式详档 Co-authored-by: rookie_hongchuan<hongchuan6@h-partners.com> # message auto-generated for no-merge-commit merge: !818 merge docs/quantization-mode into master [Doc] 新增量化模式术语词条与量化模式详档 Created-by: rookie_hongchuan Commit-by: rookie_hongchuan Merged-by: ascend-robot Description: # 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_basic、quantization_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. 功能验证 - [x] 功能自验(文档结构与链接校验,见复现步骤) - [x] 文档门禁 CI 通过(markdownlint / link-validity-check / resource-existence-check / tag-closed-check) - [ ] 本地自验用例截图(请勿包含个人信息;可附复现命令) **复现步骤(可选):** bash # 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) **典型安全编码问题** - [x] 是否已校验外部数据 —— N/A(无代码变更) - [x] 是否未采集或打印敏感信息 —— N/A(无代码变更) - [x] 是否已正确设置文件权限 —— N/A(无代码变更) - [x] 是否充分考虑浮点运算溢出、除零等异常场景 —— N/A(无代码变更) - [x] 是否已对正则表达式做 ReDos 检查 —— N/A(无代码变更) **DT** - [x] 是否具备 UT 测试用例看护(路径:用例路径;未添加请说明原因)—— 无代码变更,无需 UT - [x] 是否需要添加冒烟:否(纯文档 PR) ## 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 修复,第二轮复核确认通过。 See merge request: Ascend/msmodelslim!818 | 12 天前 |
| [Doc] 修正量化模式词条「词条类别」头部链接指向(Fix #459) Co-authored-by: rookie_hongchuan<hongchuan6@h-partners.com> # message auto-generated for no-merge-commit merge: !839 merge fix/docs-term-category-link into master [Doc] 修正量化模式词条「词条类别」头部链接指向(Fix #459) Created-by: rookie_hongchuan Commit-by: rookie_hongchuan Merged-by: ascend-robot Description: 关联 Issue:[Fix #459](https://gitcode.com/Ascend/msmodelslim/issues/459)(量化模式词条「词条类别」头部元数据链接指向错误) ## 1. 影响面评估 **接口变更(按需):** 无 **输出件变更(按需):** 无 **非兼容变更(按需):** 无 **SIG 评审结论(按需):** 无 ## 2. 修改描述 **修改背景(可选):** PR #818 合入的量化模式词条中,子类别词条顶部信息框 **词条类别** 字段的类别链接误用 ../README.md,从词条所在目录解析后指向上一层「量化模式」而非锚文本所示的当前类别(线性层量化 / FA 量化 / KVCache 量化),锚文本与链接目标不一致。另外,e4848d87(分解量化算法文档)将 quantization_algorithms/ 下算法文档拆分为 term_*/usage_* 双文件后,词条对算法文档的引用仍指向旧单文件,导致 16 个词条文件内共 40 处链接失效(首次 CI 的 link-validity 检查暴露)。后续 AIDD 静态检测对部分量化模式词条提出格式/术语/错别字问题,其中「接受-未修改」项需在本 PR 一并收敛。 **修改目的:** ① 修正 16 个词条文件头部元数据的类别链接,使其指向直接父级类别 README,与第 4 节关联词条中的既有正确写法保持一致;② 同步修正词条对算法文档的失效引用,使文档 CI 的 link-validity 检查通过;③ 按 AIDD「接受-未修改」项修复相关词条的代码格式、术语与漏字问题(「拒绝-误报」项不改)。 **修改内容:**(按「概念 - 变化」分条) - docs:linear_layer_quantization/ 下 12 个词条头部 [线性层量化](../README.md) → [线性层量化](README.md) - docs:fa_quantization/ 下 3 个词条头部 [FA 量化](../README.md) → [FA 量化](README.md) - docs:kv_cache_quantization/ 下 1 个词条头部 [KVCache 量化](../README.md) → [KVCache 量化](README.md) - docs:16 个词条文件内对 quantization_algorithms/ 算法文档的 40 处失效引用按锚文本语义更新——书名号《...说明/方案说明》指向 usage_*.md,纯术语引用(如 SmoothQuant)指向 term_*.md - docs(AIDD):term_w8a16_static.md — 为 FP16/BF16、量化模式名(如 W8A8)、per-channel/per-token/per-tensor、YAML 等标识补齐反引号代码格式 - docs(AIDD):term_fa_perhead.md — 「INT8/FP8 整数格式」更正为「INT8/FP8 数据格式」(FP8 非整数格式) - docs(AIDD):term_w4a4_mx_dynamic.md — 公式说明中 $q_i$ 由「量化尾数」更正为「MX 格式量化值」 - docs(AIDD):term_kv_cache_perchannel.md — 「在省 KV 显存」更正为「在节省 KV 显存」 ## 3. 功能验证 - [x] 功能自验(本地 markdownlint 全过;改动后链接均指向存在的目标文件) - [x] AIDD「接受-未修改」项已按建议落盘;「拒绝-误报」项保持原文不动 **复现步骤(可选):** bash # 本地 markdownlint 校验(CI 规则集:MD001 + MD012 + MD022) npx markdownlint-cli2 --config '{MD001:true,MD012:{maximum:1},MD022:{linesAbove:1,linesBelow:1},MD013:false,MD034:false,MD060:false}' docs/zh/knowledge_base/quantization_mode/ ## 4. 自检(请逐项确认,不适用标 N/A) **典型安全编码问题**(纯文档改动,全部 N/A) - [x] N/A 是否已校验外部数据 - [x] N/A 是否未采集或打印敏感信息 - [x] N/A 是否已正确设置文件权限 - [x] N/A 是否充分考虑浮点运算溢出、除零等异常场景 - [x] N/A 是否已对正则表达式做 ReDos 检查 **DT** - [x] N/A 是否具备 UT 测试用例看护(纯文档改动,无需单测;由文档 CI 门禁覆盖) - [x] N/A 是否需要添加冒烟(否) See merge request: Ascend/msmodelslim!839 | 8 天前 |
| [Doc] 修正量化模式词条「词条类别」头部链接指向(Fix #459) Co-authored-by: rookie_hongchuan<hongchuan6@h-partners.com> # message auto-generated for no-merge-commit merge: !839 merge fix/docs-term-category-link into master [Doc] 修正量化模式词条「词条类别」头部链接指向(Fix #459) Created-by: rookie_hongchuan Commit-by: rookie_hongchuan Merged-by: ascend-robot Description: 关联 Issue:[Fix #459](https://gitcode.com/Ascend/msmodelslim/issues/459)(量化模式词条「词条类别」头部元数据链接指向错误) ## 1. 影响面评估 **接口变更(按需):** 无 **输出件变更(按需):** 无 **非兼容变更(按需):** 无 **SIG 评审结论(按需):** 无 ## 2. 修改描述 **修改背景(可选):** PR #818 合入的量化模式词条中,子类别词条顶部信息框 **词条类别** 字段的类别链接误用 ../README.md,从词条所在目录解析后指向上一层「量化模式」而非锚文本所示的当前类别(线性层量化 / FA 量化 / KVCache 量化),锚文本与链接目标不一致。另外,e4848d87(分解量化算法文档)将 quantization_algorithms/ 下算法文档拆分为 term_*/usage_* 双文件后,词条对算法文档的引用仍指向旧单文件,导致 16 个词条文件内共 40 处链接失效(首次 CI 的 link-validity 检查暴露)。后续 AIDD 静态检测对部分量化模式词条提出格式/术语/错别字问题,其中「接受-未修改」项需在本 PR 一并收敛。 **修改目的:** ① 修正 16 个词条文件头部元数据的类别链接,使其指向直接父级类别 README,与第 4 节关联词条中的既有正确写法保持一致;② 同步修正词条对算法文档的失效引用,使文档 CI 的 link-validity 检查通过;③ 按 AIDD「接受-未修改」项修复相关词条的代码格式、术语与漏字问题(「拒绝-误报」项不改)。 **修改内容:**(按「概念 - 变化」分条) - docs:linear_layer_quantization/ 下 12 个词条头部 [线性层量化](../README.md) → [线性层量化](README.md) - docs:fa_quantization/ 下 3 个词条头部 [FA 量化](../README.md) → [FA 量化](README.md) - docs:kv_cache_quantization/ 下 1 个词条头部 [KVCache 量化](../README.md) → [KVCache 量化](README.md) - docs:16 个词条文件内对 quantization_algorithms/ 算法文档的 40 处失效引用按锚文本语义更新——书名号《...说明/方案说明》指向 usage_*.md,纯术语引用(如 SmoothQuant)指向 term_*.md - docs(AIDD):term_w8a16_static.md — 为 FP16/BF16、量化模式名(如 W8A8)、per-channel/per-token/per-tensor、YAML 等标识补齐反引号代码格式 - docs(AIDD):term_fa_perhead.md — 「INT8/FP8 整数格式」更正为「INT8/FP8 数据格式」(FP8 非整数格式) - docs(AIDD):term_w4a4_mx_dynamic.md — 公式说明中 $q_i$ 由「量化尾数」更正为「MX 格式量化值」 - docs(AIDD):term_kv_cache_perchannel.md — 「在省 KV 显存」更正为「在节省 KV 显存」 ## 3. 功能验证 - [x] 功能自验(本地 markdownlint 全过;改动后链接均指向存在的目标文件) - [x] AIDD「接受-未修改」项已按建议落盘;「拒绝-误报」项保持原文不动 **复现步骤(可选):** bash # 本地 markdownlint 校验(CI 规则集:MD001 + MD012 + MD022) npx markdownlint-cli2 --config '{MD001:true,MD012:{maximum:1},MD022:{linesAbove:1,linesBelow:1},MD013:false,MD034:false,MD060:false}' docs/zh/knowledge_base/quantization_mode/ ## 4. 自检(请逐项确认,不适用标 N/A) **典型安全编码问题**(纯文档改动,全部 N/A) - [x] N/A 是否已校验外部数据 - [x] N/A 是否未采集或打印敏感信息 - [x] N/A 是否已正确设置文件权限 - [x] N/A 是否充分考虑浮点运算溢出、除零等异常场景 - [x] N/A 是否已对正则表达式做 ReDos 检查 **DT** - [x] N/A 是否具备 UT 测试用例看护(纯文档改动,无需单测;由文档 CI 门禁覆盖) - [x] N/A 是否需要添加冒烟(否) See merge request: Ascend/msmodelslim!839 | 8 天前 |
| [Doc] 修正量化模式词条「词条类别」头部链接指向(Fix #459) Co-authored-by: rookie_hongchuan<hongchuan6@h-partners.com> # message auto-generated for no-merge-commit merge: !839 merge fix/docs-term-category-link into master [Doc] 修正量化模式词条「词条类别」头部链接指向(Fix #459) Created-by: rookie_hongchuan Commit-by: rookie_hongchuan Merged-by: ascend-robot Description: 关联 Issue:[Fix #459](https://gitcode.com/Ascend/msmodelslim/issues/459)(量化模式词条「词条类别」头部元数据链接指向错误) ## 1. 影响面评估 **接口变更(按需):** 无 **输出件变更(按需):** 无 **非兼容变更(按需):** 无 **SIG 评审结论(按需):** 无 ## 2. 修改描述 **修改背景(可选):** PR #818 合入的量化模式词条中,子类别词条顶部信息框 **词条类别** 字段的类别链接误用 ../README.md,从词条所在目录解析后指向上一层「量化模式」而非锚文本所示的当前类别(线性层量化 / FA 量化 / KVCache 量化),锚文本与链接目标不一致。另外,e4848d87(分解量化算法文档)将 quantization_algorithms/ 下算法文档拆分为 term_*/usage_* 双文件后,词条对算法文档的引用仍指向旧单文件,导致 16 个词条文件内共 40 处链接失效(首次 CI 的 link-validity 检查暴露)。后续 AIDD 静态检测对部分量化模式词条提出格式/术语/错别字问题,其中「接受-未修改」项需在本 PR 一并收敛。 **修改目的:** ① 修正 16 个词条文件头部元数据的类别链接,使其指向直接父级类别 README,与第 4 节关联词条中的既有正确写法保持一致;② 同步修正词条对算法文档的失效引用,使文档 CI 的 link-validity 检查通过;③ 按 AIDD「接受-未修改」项修复相关词条的代码格式、术语与漏字问题(「拒绝-误报」项不改)。 **修改内容:**(按「概念 - 变化」分条) - docs:linear_layer_quantization/ 下 12 个词条头部 [线性层量化](../README.md) → [线性层量化](README.md) - docs:fa_quantization/ 下 3 个词条头部 [FA 量化](../README.md) → [FA 量化](README.md) - docs:kv_cache_quantization/ 下 1 个词条头部 [KVCache 量化](../README.md) → [KVCache 量化](README.md) - docs:16 个词条文件内对 quantization_algorithms/ 算法文档的 40 处失效引用按锚文本语义更新——书名号《...说明/方案说明》指向 usage_*.md,纯术语引用(如 SmoothQuant)指向 term_*.md - docs(AIDD):term_w8a16_static.md — 为 FP16/BF16、量化模式名(如 W8A8)、per-channel/per-token/per-tensor、YAML 等标识补齐反引号代码格式 - docs(AIDD):term_fa_perhead.md — 「INT8/FP8 整数格式」更正为「INT8/FP8 数据格式」(FP8 非整数格式) - docs(AIDD):term_w4a4_mx_dynamic.md — 公式说明中 $q_i$ 由「量化尾数」更正为「MX 格式量化值」 - docs(AIDD):term_kv_cache_perchannel.md — 「在省 KV 显存」更正为「在节省 KV 显存」 ## 3. 功能验证 - [x] 功能自验(本地 markdownlint 全过;改动后链接均指向存在的目标文件) - [x] AIDD「接受-未修改」项已按建议落盘;「拒绝-误报」项保持原文不动 **复现步骤(可选):** bash # 本地 markdownlint 校验(CI 规则集:MD001 + MD012 + MD022) npx markdownlint-cli2 --config '{MD001:true,MD012:{maximum:1},MD022:{linesAbove:1,linesBelow:1},MD013:false,MD034:false,MD060:false}' docs/zh/knowledge_base/quantization_mode/ ## 4. 自检(请逐项确认,不适用标 N/A) **典型安全编码问题**(纯文档改动,全部 N/A) - [x] N/A 是否已校验外部数据 - [x] N/A 是否未采集或打印敏感信息 - [x] N/A 是否已正确设置文件权限 - [x] N/A 是否充分考虑浮点运算溢出、除零等异常场景 - [x] N/A 是否已对正则表达式做 ReDos 检查 **DT** - [x] N/A 是否具备 UT 测试用例看护(纯文档改动,无需单测;由文档 CI 门禁覆盖) - [x] N/A 是否需要添加冒烟(否) See merge request: Ascend/msmodelslim!839 | 8 天前 |