已合并
[Doc] 整改知识库 quantization_algorithms 量化算法文档 #876
[Doc] 整改知识库 quantization_algorithms 量化算法文档 #876
已合并
wanlongze123创建于 13 天前
wanlongze123
wanlongze123成员
13 天前

PR 提交说明

提交前请阅读 贡献指南,开发者文档:模型接入指南

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

1. 影响面评估

接口变更(按需):

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

输出件变更(按需):

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

非兼容变更(按需):

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

SIG 评审结论(按需):

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

2. 修改描述

修改背景(可选): 量化算法知识库文档结构不一致,词条(term)与使用指南(usage)的格式模板不统一,导致用户查阅时理解成本高;部分文档缺失阅读指引和关联知识链接,不利于从算法总览到具体配置的渐进式阅读。

修改目的: 统一文档模板,完善阅读指引和关联跳转,降低用户理解门槛。

修改内容:

  • docs/知识库:重构量化算法知识库文档模板,统一词条(term)与使用指南(usage)的文档结构;词条统一采用「概述 → 原理 → 性质 → 适用场景 → 关联知识」结构,使用指南统一采用「功能定义 → 配置参数 → 何时调整 → 使用示例」结构
  • docs/知识库:新增 ra_compress 算法词条与使用指南,覆盖低秩注意力压缩量化方案
  • docs/知识库:README 总览页补充阅读建议,引导用户先读词条再读使用指南,并指向 modelslim_v1 配置说明文档
  • docs/知识库:各算法文档外链从相对路径改为 README 锚点跳转,支持跨文档快速导航

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

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

3. 功能验证

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

复现步骤(可选):

# 文档变更,无运行验证步骤

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

典型安全编码问题

DT

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

变更摘要

本 PR 为纯文档变更([Doc]),主要针对 docs/知识库 下量化算法(quantization_algorithms)知识库文档进行整改,目的是统一文档模板、完善阅读指引和关联跳转,降低用户查阅时的理解成本。整体思路是让文档从「算法总览 → 词条讲解 → 使用指南」形成渐进式阅读链路,并保持各文档结构一致。本次共涉及 63 个文件,主要是对既有文档结构的重组与内容精简,未涉及任何接口、输出件或非兼容性变更。

主要改动

  • 统一文档模板结构:词条(term)统一采用「概述 → 原理 → 性质 → 适用场景 → 关联知识」结构,使用指南(usage)统一采用「功能定义 → 配置参数 → 何时调整 → 使用示例」结构,消除各文档格式不一致的问题
  • 新增 ra_compress 算法文档:补充低秩注意力压缩量化方案的词条与使用指南,完善该量化算法的知识覆盖
  • README 总览页补充阅读建议:新增引导说明,建议用户先阅读词条再阅读使用指南,并指向 modelslim_v1 配置说明文档,方便定位
- **外链改为 README 锚点跳转**:各算法文档中的外部链接由相对路径改为 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.
You can self-configure the PR merge rules for this repository. For more details, please refer to 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 yejiajun, 王建新 (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

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

likedislike
此处折叠了49条消息 查看更多
ascend-robotascend-robot成员
11 天前 添加了label:docs-ci-pipeline-success
yejj
11 天前 评论:

/lgtm

likedislike
keith_wa
keith_wa成员
10 天前 评论:

/lgtm
/approve

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