已合并
[Doc] fix broken links in term glossary template and kvcache quantization README #853
[Doc] fix broken links in term glossary template and kvcache quantization README #853
已合并
zhangwl创建于 6 天前
zhangwl
zhangwl成员
6 天前

PR 提交说明

提交前请阅读 https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/contributing_guide.md ,开发者文档:模型接入指南

PR 标题前缀:[Feature]、[Bugfix]、[Doc]、[Test](与 CONTRIBUTING 一致)

1. 影响面评估

接口变更(按需):

备注:若无变更请保留「无」;涉及 CLI、API、YAML 等请在此项补充说明。

输出件变更(按需):

备注:若无变更请保留「无」;涉及导出格式、产物路径等请在此项补充说明。

非兼容变更(按需):

备注:若无变更请保留「无」;若有非兼容变更请说明迁移方式。

SIG 评审结论(按需):

提醒:非兼容、安全风险等高危 PR 须经 SIG 评审后合入;无则保留「无」。

2. 修改描述

修改背景(可选):
文档中存在相对路径错误的内部链接,点击后返回 404,影响开发者查阅校验清单与配套术语词条。

修改目的:
修复两处文档中的失效内部链接,使链接指向真实存在的文件。

修改内容:

  1. docs/zh/contributing/development_guide/docs_standards/01_term_glossary_template.md

    • 修复「量化术语百科校验清单」链接:01_quantization_glossary_checklist.md01_term_glossary_checklist.md(原链接多写了 quantization_ 前缀,实际文件名为 01_term_glossary_checklist.md
  2. docs/zh/knowledge_base/quantization_mode/kv_cache_quantization/README.md

    • 修复「KVCache量化:缓存量化算法说明」词条链接(关联词条 + 参考资料,共 2 处):kvcache_quant/kvcache_quant.mdkvcache_quant/term_kvcache_quant.md(缺少 term_ 前缀)
    • 修复「KVSmooth:KVCache量化离群值抑制算法说明」词条链接(1 处):kv_smooth/kv_smooth.mdkv_smooth/term_kv_smooth.md(缺少 term_ 前缀)

概念域参考(填写提示):

  • cli:命令行 quant / analyze / tune
  • app:最佳实践量化、量化分析、精度反馈自动调优等
  • core:算法、量化服务、调度、张量量化、调优策略、最佳实践、上下文等
  • infra:模型适配、调优计划/历史/缓存、测评服务等
  • utils:日志、错误处理、插件等

3. 功能验证

冒烟由 CI 门禁检查,无需填写「冒烟是否通过」。

复现步骤(可选):

# 修复前点击以下链接返回 404,修复后可正常跳转:
# 1. 01_term_glossary_template.md 中的「量化术语百科校验清单」
# 2. kv_cache_quantization/README.md 中的「KVCache量化:缓存量化算法说明」「KVSmooth:KVCache量化离群值抑制算法说明」

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

典型安全编码问题

  • [] 是否已校验外部数据
  • [] 是否未采集或打印敏感信息
  • [] 是否已正确设置文件权限
  • [] 是否充分考虑浮点运算溢出、除零等异常场景
  • [] 是否已对正则表达式做 ReDos 检查

DT

  • [] 是否具备 UT 测试用例看护(路径:用例路径;未添加请说明原因)
  • [] 是否需要添加冒烟:否(若「是」请说明冒烟场景及对应用途)
likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 zhangwl 的贡献)
atomgit-bot
atomgit-bot
6 天前 评论:

🤖 正在生成合并请求摘要,请稍候…

likedislike
atomgit-bot
atomgit-bot
6 天前 评论:

🤖 AI 代码检视正在进行中,请稍候…

likedislike
xzm123成员
6 天前 评论:

🤖 AIDD 文档质量检测报告

PR #853 的文档检测已全部完成。

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

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

评论由 AIDD 自动生成,多次推送会增量更新本评论。

likedislike
ascend-robotascend-robot成员
6 天前 添加了label:ascend-cla/no
ascend-robotascend-robot成员
6 天前 添加了label:stat/needs-squash
ascend-robot
ascend-robot成员
6 天前 评论:

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 王建新, rookie_hongchuan (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

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

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

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
6 天前 添加了label:docs-ci-pipeline-running
zhangwlzhangwl成员
6 天前 强制推送  8 个提交:bb78d4dc-7 commits from branch mastere411208f-docs: fix broken links in term glossary template and kvcache quantization README
ascend-robotascend-robot成员
6 天前 删除了label:stat/needs-squash
ascend-robotascend-robot成员
6 天前 删除了label:ascend-cla/no
ascend-robot
ascend-robot成员
6 天前 评论:

Notification

This pull request has been changed(code update) or closed, so removes the following label(s): stat/needs-squash.

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

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robotascend-robot成员
6 天前 删除了label:docs-ci-pipeline-running
ascend-robotascend-robot成员
6 天前 添加了label:docs-ci-pipeline-success
zhangwl
zhangwl成员
6 天前 评论:

compile

likedislike
AtlasAccountAtlasAccount成员
6 天前 添加了label:ci-pipeline-running
AtlasAccountAtlasAccount成员
6 天前 删除了label:ci-pipeline-running
AtlasAccountAtlasAccount成员
6 天前 添加了label:ci-pipeline-passed
AtlasAccount
AtlasAccount成员
6 天前 评论:
流水线 PR-pipeline_msmodelslim#2286 [ commitID:e411208f ] 已完成
>>>代码风格自动修复执行成功(无修复内容)
阶段 任务名 状态 详情
编译构建 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
zhangwlzhangwl成员
6 天前 关联了issue:[Doc]: 文档链接失效:01_quantization_glossary_checklist.md 文件不存在
zhangwlzhangwl成员
6 天前 关联了issue:[Doc]: 文档链接失效:kv_smooth.md 文件不存在
rookie_hongchuan成员
6 天前 评论:

/lgtm

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

ascend docs pipeline is running...

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

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robot
ascend-robot成员
6 天前 评论:

ascend docs pipeline is running...

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

/lgtm
/approve

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

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robotascend-robot成员
6 天前 删除了label:docs-ci-pipeline-running