已合并
[Doc] 修正量化模式词条「词条类别」头部链接指向(Fix #459) #839
[Doc] 修正量化模式词条「词条类别」头部链接指向(Fix #459) #839
已合并
rookie_hongchuan创建于 13 天前
rookie_hongchuan成员
13 天前

关联 Issue:Fix #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-tensorYAML 等标识补齐反引号代码格式
  • 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. 功能验证

复现步骤(可选):

# 本地 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)

DT

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 rookie_hongchuan 的贡献)
Rrookie_hongchuan成员
13 天前 关联了issue:[Doc]: 量化模式词条「词条类别」头部元数据链接指向错误(16 个文件)
atomgit-bot
atomgit-bot
13 天前 评论:

变更摘要

该 PR 为纯文档修复(对应 Issue #459),旨在修正量化模式知识库中 16 个词条文件头部「词条类别」元数据框内的类别链接指向错误。此前这些链接统一写作 ../README.md,从词条所在目录解析后会指向上一层「量化模式」目录,与锚文本所示的直接父级类别(线性层量化 / FA 量化 / KVCache 量化)不一致。本次将链接统一改为 README.md,使其指向各词条的直接父级类别 README,与第 4 节关联词条中的既有正确写法保持一致。

主要改动

  • linear_layer_quantization/ 词条链接修正:将该目录下 12 个词条头部元数据中的 [线性层量化](../README.md) 改为 [线性层量化](README.md),使链接指向当前目录的直接父级类别 README。
  • fa_quantization/ 词条链接修正:将该目录下 3 个词条头部元数据中的 [FA 量化](../README.md) 改为 [FA 量化](README.md),使链接指向当前目录的直接父级类别 README。
  • kv_cache_quantization/ 词条链接修正:将该目录下 1 个词条头部元数据中的 [KVCache 量化](../README.md) 改为 [KVCache 量化](README.md),使链接指向当前目录的直接父级类别 README。
likedislike
atomgit-bot
atomgit-bot
13 天前 评论:

🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。

likedislike
ascend-robotascend-robot成员
13 天前 添加了label:ascend-cla/yes
ascend-robot
ascend-robot成员
13 天前 评论:

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
repo-Ascend/msmodelslim 周容辰, libarry (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

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

likedislike
xzm123成员
13 天前 评论:

🤖 AIDD 文档质量检测报告

PR #839 已关闭,相关检测任务已归档。

📊 任务统计:共 93 个任务(✅ 93 完成 / ❌ 0 失败 / ⊘ 0 取消)
🐛 问题统计:共 32 个问题(致命 0 / 严重 7 / 一般 25 / 提示 0)

🔗 查看完整报告点击进入平台报告
🔗 查看 PR 检测问题点击查看问题列表

评论由 AIDD 自动生成,PR 关闭后检测任务已归档。

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

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
13 天前 添加了label:docs-ci-pipeline-running
ascend-robot
ascend-robot成员
13 天前 评论:

❌ 文档门禁未通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ❌ 未通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情

💡 本次检查出 38 项错误,仅展示前 20 条,请通过上方表格的 “查看详情” 获取更多信息~

序号 错误详情
1 [文件路径]:docs/zh/knowledge_base/quantization_mode/fa_quantization/term_fa_perblock.md
[检查类型]:link-validity-check
[错误位置]:第 80 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/fa3_quant/fa3_quant.md
2 [文件路径]:docs/zh/knowledge_base/quantization_mode/fa_quantization/term_fa_perblock.md
[检查类型]:link-validity-check
[错误位置]:第 86 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/fa3_quant/fa3_quant.md
3 [文件路径]:docs/zh/knowledge_base/quantization_mode/fa_quantization/term_fa_perhead.md
[检查类型]:link-validity-check
[错误位置]:第 82 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/fa3_quant/fa3_quant.md
4 [文件路径]:docs/zh/knowledge_base/quantization_mode/fa_quantization/term_fa_perhead.md
[检查类型]:link-validity-check
[错误位置]:第 88 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/fa3_quant/fa3_quant.md
5 [文件路径]:docs/zh/knowledge_base/quantization_mode/kv_cache_quantization/term_kv_cache_perchannel.md
[检查类型]:link-validity-check
[错误位置]:第 76 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/kvcache_quant/kvcache_quant.md
6 [文件路径]:docs/zh/knowledge_base/quantization_mode/kv_cache_quantization/term_kv_cache_perchannel.md
[检查类型]:link-validity-check
[错误位置]:第 77 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/kv_smooth/kv_smooth.md
7 [文件路径]:docs/zh/knowledge_base/quantization_mode/kv_cache_quantization/term_kv_cache_perchannel.md
[检查类型]:link-validity-check
[错误位置]:第 83 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/kvcache_quant/kvcache_quant.md
8 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w16a16s.md
[检查类型]:link-validity-check
[错误位置]:第 74 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
9 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w16a16s.md
[检查类型]:link-validity-check
[错误位置]:第 80 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
10 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a4_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 62 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/smooth_quant/smooth_quant.md
11 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a4_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 81 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
12 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a4_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 82 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/laos/laos.md
13 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a4_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 88 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
14 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a4_mx_dualscale.md
[检查类型]:link-validity-check
[错误位置]:第 80 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/dual_scale/dual_scale.md
15 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a4_mx_dualscale.md
[检查类型]:link-validity-check
[错误位置]:第 86 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
16 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a4_mx_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 80 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
17 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a4_mx_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 86 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
18 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a8_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 85 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
19 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a8_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 91 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
20 [文件路径]:docs/zh/knowledge_base/quantization_mode/linear_layer_quantization/term_w4a8_mx_dynamic.md
[检查类型]:link-validity-check
[错误位置]:第 79 行
[错误信息]:本地路径链接无法访问
[错误内容]:../../quantization_algorithms/linear_quant/linear_quant.md
likedislike
ascend-robotascend-robot成员
13 天前 删除了label:docs-ci-pipeline-running
ascend-robotascend-robot成员
13 天前 添加了label:docs-ci-pipeline-failed
Rrookie_hongchuan成员
13 天前 推送  1 个提交:8f357c9a-docs(knowledge_base): 修复量化模式词条对算法文档的失效引用
ascend-robotascend-robot成员
13 天前 删除了label:ascend-cla/yes
ascend-robotascend-robot成员
13 天前 添加了label:ascend-cla/yesstat/needs-squash
Rrookie_hongchuan成员
13 天前 修改了pull request 的描述
ascend-robot
ascend-robot成员
13 天前 评论:

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
13 天前 删除了label:docs-ci-pipeline-failed
ascend-robotascend-robot成员
13 天前 添加了label:docs-ci-pipeline-running
ascend-robot
ascend-robot成员
13 天前 评论:

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robotascend-robot成员
13 天前 删除了label:docs-ci-pipeline-running
此处折叠了7条事件消息 查看更多
Rrookie_hongchuan成员
13 天前 修改了pull request 的描述
rookie_hongchuan成员
10 天前 评论:

compile

likedislike
Rrookie_hongchuan成员
10 天前 推送  1 个提交:9775110d-docs(knowledge_base): 修复量化模式词条 AIDD 检视问题
ascend-robotascend-robot成员
10 天前 删除了label:ascend-cla/yes
ascend-robotascend-robot成员
10 天前 添加了label:ascend-cla/yes
AtlasAccountAtlasAccount成员
10 天前 添加了label:ci-pipeline-running
ascend-robot
ascend-robot成员
10 天前 评论:

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
10 天前 删除了label:docs-ci-pipeline-success
ascend-robotascend-robot成员
10 天前 添加了label:docs-ci-pipeline-running
ascend-robot
ascend-robot成员
10 天前 评论:

ascend docs pipeline is running...

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

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robotascend-robot成员
10 天前 删除了label:docs-ci-pipeline-running
ascend-robotascend-robot成员
10 天前 添加了label:docs-ci-pipeline-success
AtlasAccountAtlasAccount成员
10 天前 删除了label:ci-pipeline-running
AtlasAccountAtlasAccount成员
10 天前 添加了label:ci-pipeline-passed
AtlasAccount
AtlasAccount成员
10 天前 评论:
流水线 PR-pipeline_msmodelslim#2246 [ commitID:9775110d ] 已完成
>>>代码风格自动修复执行成功(无修复内容)
阶段 任务名 状态 详情
编译构建 Build_msmodelslim 🛑 >>>
恶意代码检查 Antipoison_MindStudio-ModelSlim 🛑 >>>
编码安全与规范检查 codecheck_pre-commit 🛑 >>>
md_check md_check >>>
pre-commit 🛑 >>>
开源片段检查 SCA_MindStudio-ModelSlim 🛑 >>>
开发者测试 UT_msmodelslim 🛑 >>>
PreSmoke_msmodelslim 🛑 >>>
流水线 PR-pipeline_msmodelslim >>>
此流水线已支持下列评论快捷指令,仅PR创建者和白名单成员[A1streomeria, xyxin_006, libarry, joejoezhou, xiaoheng181, rookie_hongchuan]评论有效
  • compile : 运行流水线
  • retry : 重试流水线所有失败子任务
  • retry <任务名> : 仅重试指定失败子任务
  • stop : 停止流水线
likedislike
ascend-robot
ascend-robot成员
10 天前 评论:

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
Rrookie_hongchuan成员
10 天前 修改了pull request 的描述
libowen
libowen成员
10 天前 评论:

/lgtm

likedislike
joejoezhou成员
10 天前 评论:

/lgtm
/approve

likedislike
ascend-robotascend-robot成员
10 天前 添加了label:approvedlgtm
ascend-robotascend-robot成员
10 天前 合入了pull request