已合并
[Doc] 修复文档失效链接并补齐缺失的 SVDQuant 量化模式描述 #487 #866
[Doc] 修复文档失效链接并补齐缺失的 SVDQuant 量化模式描述 #487 #866
已合并
rookie_hongchuan创建于 8 天前
rookie_hongchuan成员
8 天前

1. 影响面评估

接口变更(按需):

输出件变更(按需):

非兼容变更(按需):

SIG 评审结论(按需): 无(纯文档改动,无接口/兼容性影响)

2. 修改描述

修改背景: Issue #487:master 分支 quantization_basic / quantization_mode 两节文档存在失效的相对链接(渲染为 404)。

背景之二:SVDQuant 作为量化模式此前缺少独立的模式描述——quantization_mode/README.md 模式索引与 linear_layer_quantization/README.md 模式清单虽已列出 SVDQuant 行(含承载 IR 类),但其链接指向不存在的 svdquant/svdquant.md(算法侧实际文件名为 term_svdquant.md),且 quantization_mode/linear_layer_quantization/并无 term_svdquant.md 词条页,量化模式描述处于缺失状态。

修改目的: ① 修复全部失效链接,使 quantization_basic / quantization_mode 及直接引用 quantization_modequantization_format 文档相对链接全部可达;② 补齐此前缺失的 SVDQuant 量化模式描述——新增模式词条页,使模式索引/清单可稳定指向该词条。

修改内容:

  • docs/zh/knowledge_base/quantization_basic:term_int4.mdterm_quantization.mdquantization_algorithms/gptq/gptq.mdgptq/term_gptq.mdlaos/laos.mdlaos/term_laos.md(实际词条文件名为 term_<name>.md,不存在 <name>.md)。
  • docs/zh/knowledge_base/quantization_mode:
    • fa_quantization/README.mdfa3_quant/fa3_quant.mdfa3_quant/term_fa3_quant.md
    • linear_layer_quantization/README.mdlinear_quant/linear_quant.mdlinear_quant/term_linear_quant.md(×2);SVDQuant 行由失效的 ../../quantization_algorithms/svdquant/svdquant.md 改指本目录新增的 term_svdquant.md
    • quantization_mode/README.md 模式索引:SVDQuant 行改指 linear_layer_quantization/term_svdquant.md
  • docs/zh/knowledge_base/quantization_format:README.mdascendv1/term_ascendv1.mdcompressed_tensors/term_compressed_tensors.mdmindie_sd/term_mindie_sd.md 中引用不存在的 quantization_mode/term_quantization_mode.md(quantization_mode 总览页实际为 quantization_mode/README.md),统一改指 quantization_mode/README.md
  • 移除失效源码链接ascendv1/ascendv1_usage.md 中指向 msmodelslim/core/quant_service/modelslim_v1/save/interface.py 的相对路径链接(差一级 ../,渲染 404),移除链接、保留 AscendV1SaveInterface 类名文本。
  • 补齐缺失的 SVDQuant 量化模式描述:新增 quantization_mode/linear_layer_quantization/term_svdquant.md(按《量化术语百科词条模板》及 01_term_glossary_checklist.md 校验编写),并在 term_w4a4_dynamic.md 关联词条补充对该词条的反向引用。
  • AIDD 修订:term_svdquant.md 错别字(残差分量/直接量化/整数量化)、fa_quantization/README.md「存储」→「内存」及 MXFP4「尾数仅 2bit」→「1bit」、term_quantization.md「存储」→「内存」。

概念域参考: 不涉及代码概念域(docs)。

3. 功能验证

复现命令:

# 链接校验脚本:遍历 docs/zh/knowledge_base 下全部 md,解析相对链接并用 os.path 校验目标存在性
# 修复前:quantization_basic/quantization_mode 范围 9 处失效;修复后 0 处。

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

典型安全编码问题

DT

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 rookie_hongchuan 的贡献)
Rrookie_hongchuan成员
8 天前 关联了issue:[Doc]: 修复 quantization_basic/quantization_mode 文档中的失效链接
atomgit-bot
atomgit-bot
8 天前 评论:

变更摘要

该 PR 为纯文档修复(Issue #487),针对 docs/zh/knowledge_base/quantization_basicquantization_mode 两节文档及引用 quantization_modequantization_format 文档中的失效相对链接进行全量修正,使相关词条页与总览页的链接均可达。通过脚本对全部 markdown 相对链接做存在性校验,共定位 8 个文件、21 处失效引用,修复后该范围内失效链接降为 0 处;无接口、输出件及兼容性变更。

主要改动

  • quantization_basic 词条链接修正term_int4.mdterm_quantization.md 中将 quantization_algorithms/gptq/gptq.mdlaos/laos.md 分别改为实际的词条文件名 gptq/term_gptq.mdlaos/term_laos.md(词条文件均以 term_<name>.md 命名,不存在 <name>.md)。
  • quantization_mode 词条链接修正fa_quantization/README.mdfa3_quant/fa3_quant.md 改为 fa3_quant/term_fa3_quant.mdlinear_layer_quantization/README.mdsvdquant/svdquant.mdlinear_quant/linear_quant.md 分别改为 svdquant/term_svdquant.mdlinear_quant/term_linear_quant.md
  • quantization_format 引用修正README.mdascendv1/term_ascendv1.mdcompressed_tensors/term_compressed_tensors.mdmindie_sd/term_mindie_sd.md 中引用不存在的 quantization_mode/term_quantization_mode.md 统一改指实际存在的总览页 quantization_mode/README.md
likedislike
atomgit-bot
atomgit-bot
8 天前 评论:

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

likedislike
ascend-robotascend-robot成员
8 天前 添加了label:ascend-cla/yes
此处折叠了97条消息 查看更多
ascend-robotascend-robot成员
6 天前 添加了label:docs-ci-pipeline-success
libowen
libowen成员
3 天前 评论:

/lgtm

likedislike
LeeQT成员
3 天前 评论:

/lgtm
/approve

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