已合并
[Doc] 量化算法、PTQ对应资料内容整体整改 #972
[Doc] 量化算法、PTQ对应资料内容整体整改 #972
已合并
wanlongze123创建于 3 天前
wanlongze123
wanlongze123成员
3 天前

PR 描述

PR 标题: [Doc] 规范化PTQ与量化算法知识库文档(词条去私有化、使用指南流程重构、接入指南精简、格式整改、旧接入文档移除重定向)并补全权重转换 CLI/YAML/多卡说明

涉及提交:

  • 08cb03a3 [Doc] 规范化PTQ与量化算法知识库文档:词条去私有化、使用指南流程重构与格式整改、旧接入文档移除重定向、产品系列名称规范化,并补全权重转换 CLI/YAML/多卡说明(110 个文件,+4286/-5918)

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

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

1. 影响面评估

接口变更(按需):

备注:本 PR 为纯文档变更,不涉及 CLI、API、YAML 等接口。

输出件变更(按需):

备注:不涉及导出格式、产物路径等。

非兼容变更(按需):

备注:仅知识库文档内容整改,无行为变更,无需迁移。

SIG 评审结论(按需):

说明:非兼容、安全风险等高危项均不涉及。

2. 修改描述

修改背景(可选):

知识库 docs/zh/knowledge_base/ptqdocs/zh/knowledge_base/quantization_algorithms 两个目录的资料经测试反馈存在以下问题:

  1. 词条(term)文件掺杂 modelslim 特有特性(逐层量化、runner 等),不符合「词条讲述通用量化特性」的定位,且未按词条模板组织;
  2. 校准集数量表述不统一,需统一为推荐 50 条;W4A16 相关内容按规范不应体现;部分文档残留明显 AI 味提示词;
  3. PTQ 使用指南流程总览与操作步骤结构冗余,缺少可直达的操作路径;
  4. 量化算法使用指南(usage)整体流程不完整,缺少前置的「模型适配」阶段(未体现 msmodelslim/model/interface_hub.py 相关接口),且缺少指向 user guide 的更多信息跳转链接;
  5. 格式低错:标题层级、标点符号,term 词条章节分隔方式不统一,usage/integration_guide 步骤间残留多余分隔线,流程图长节点未换行、缺少流程总览图;
  6. knowledge_base/model 目录下三个旧接入文档(integrating_models.md、integrating_multimodal_generation_model.md、integrating_multimodal_understanding_model.md)与新 ptq 接入指南内容重复且已废弃,需移除并重定向全库引用;
  7. 权重转换 CLI 命令文档与 modelslim_convert 配置协议说明不完整,缺少 CLI 命令、YAML 配置与多卡执行等关键说明;知识库部分 README 与实际目录结构不一致。

修改目的:

规范化 PTQ 与量化算法知识库文档,使术语词条聚焦通用量化特性、使用指南形成「适配 → 校准集 → 保存格式 → 算法 → runner → 量化命令」的完整可操作路径、接入指南聚焦接口职责并串联实际案例,统一文档格式规范,移除废弃旧接入文档并统一引用入口至 ptq 接入指南,补全权重转换 CLI/YAML/多卡资料并纠正知识库结构,提升资料准确性、一致性与易用性。

修改内容:

  • docs / PTQ 词条:PTQ、LLM、VLM、DiT、权重转换等 term 词条剥离 modelslim 特有内容(逐层量化、runner 等),按词条模板重构,删减量化特点篇幅,重点突出 LLM/VLM/DiT 三类模型的量化特点。
  • docs / PTQ 使用指南usage_large_language_model_quantization.md 等 usage 文档去掉流程总览与操作步骤旧结构,统一按步骤 1-6(模型适配 V1 interface → 选择校准集 → 选择保存格式 → 选择算法 → runner → 量化命令)重写,补充静态量化/动态量化 yaml 与 W8A8 完整示例配置及命令行;校准集统一为推荐 50 条。
  • docs / PTQ 接入指南:LLM/VLM/DiT 三篇 integration_guide 精简大段代码展示,聚焦接口含义与输入输出说明,补充 DeepSeek、Kimi 等实际模型量化案例的跳转链接,并与使用指南去重(V1 Interface 介绍收敛至接入指南,使用指南以链接引用)。
  • docs / 量化算法词条quantization_algorithms 下 33 个算法目录的 term 词条去私有化表述,统一校准集推荐 50 条,删除 W4A16 相关内容,清理 AI 味提示词,修正标题与标点格式。
  • docs / 量化算法使用指南:usage 文档在流程开头新增「模型适配」阶段,覆盖 msmodelslim/msmodelslim/model/interface_hub.py 涉及的适配接口(先适配、后算法);文末统一新增「更多量化信息」跳转链接至 权重量化使用指南;整体格式参考 usage_quarot.md 对齐。
  • docs / 格式整改:知识库 term 词条章节统一以 --- 分隔;usage/integration_guide 删除步骤间多余分隔线;使用指南新增流程总览图并优化流程图长节点换行(涉及 ptq、quantization_algorithms 等 47 个文件)。
  • docs / 旧接入文档移除重定向:移除 knowledge_base/model 目录下三个旧接入文档(integrating_models.md、integrating_multimodal_generation_model.md、integrating_multimodal_understanding_model.md),best_practices、user_guide、knowledge_base、mkdocs.yml 等全库引用统一重定向至 ptq 目录下对应接入指南(llm/vlm/dit 三类 integration_guide),消除死链与内容重复(23 个文件)。
  • docs / 权重转换资料补全msmodelslim quant CLI 文档补全权重转换命令说明;modelslim_convert 配置协议说明补充 YAML 配置与多卡执行等字段说明;纠正 knowledge_base 及 parallel 目录 README 与实际结构不一致问题。
  • docs / 流程总览与死链收尾:llm/vlm/dit 三篇 usage 流程总览「前置条件:模型适配」改为独立文字段落,阶段列表与流程图节点对齐;修复 skills、example 中引用已删除文档的残留死链;Wan2.2 W4A4F4 案例产品系列名称规范化(昇腾950PR&950DT → Ascend 950PR&950DT)。

概念域参考:

  • core:量化算法词条与使用指南(33 个算法的 term/usage)
  • infra:模型适配(interface_hub 接口)相关文档、PTQ 使用/接入指南

3. 功能验证

本 PR 为纯文档变更,不涉及代码路径,冒烟由 CI 门禁检查。

复现步骤(可选):

# 查看本 PR 全部改动(也可直接查看分支整体 diff:git diff upstream/master..ziliao_fix_wlz -- docs/ skills/ example/)
git diff 08cb03a3^..08cb03a3 -- docs/zh mkdocs.yml skills example

# 本地预览(可选)
# 使用任意 Markdown 渲染工具查看上述文档渲染效果

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

典型安全编码问题

DT

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 wanlongze123 的贡献)
wanlongze123wanlongze123成员
3 天前 创建了 pull request,commit 2ac73702
atomgit-bot
atomgit-bot
3 天前 评论:

变更摘要

本 PR 为纯文档整改,旨在规范化 docs/zh/knowledge_base/ptqdocs/zh/knowledge_base/quantization_algorithms 两个知识库目录的资料:使术语词条聚焦通用量化特性(剥离 modelslim 特有内容)、让 PTQ 与量化算法使用指南形成「模型适配 → 校准集 → 保存格式 → 算法 → runner → 量化命令」的完整可操作路径、精简接入指南并聚焦接口职责,同时统一校准集推荐数量、删除不合规的 W4A16 相关内容并修正格式问题。整个变更不涉及 CLI、API、YAML 等接口,无行为变更。

主要改动

  • PTQ 词条去私有化重构ptq 目录下 PTQ、LLM、VLM、DiT、权重转换等 term 词条剥离 modelslim 特有内容(逐层量化、runner 等),按词条模板组织,删减量化特点篇幅并重点突出 LLM/VLM/DiT 三类模型的量化特点。
  • PTQ 使用指南流程重写usage_large_language_model_quantization.md 等 usage 文档去掉流程总览与操作步骤旧结构,统一按步骤 1-6(模型适配 V1 interface → 选择校准集 → 选择保存格式 → 选择算法 → runner → 量化命令)重写,补充静态/动态量化 yaml 与 W8A8 完整示例配置及命令行,校准集统一为推荐 50 条。
  • PTQ 接入指南精简并去重:LLM/VLM/DiT 三篇 integration_guide 精简大段代码展示,聚焦接口含义与输入输出说明,补充 DeepSeek、Kimi 等实际模型量化案例的跳转链接;V1 Interface 介绍收敛至接入指南,使用指南改为链接引用以避免重复。
  • 量化算法词条整改quantization_algorithms 下 33 个算法目录的 term 词条统一去私有化表述、校准集推荐 50 条,删除 W4A16 相关内容,清理 AI 味提示词,并修正标题层级与标点格式。
  • 量化算法使用指南补齐模型适配阶段:usage 文档在流程开头新增「模型适配」阶段,覆盖 msmodelslim/msmodelslim/model/interface_hub.py 涉及的适配接口(先适配、后算法),文末统一新增「更多量化信息」跳转链接至权重量化使用指南(usage_weight_quantization.md),整体格式对齐 usage_quarot.md
likedislike
不准确?
atomgit-bot
atomgit-bot
3 天前 评论:

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

likedislike
不准确?
ascend-robotascend-robot成员
3 天前 添加了label:stat/needs-squash
此处折叠了122条消息 查看更多
keith_wa
keith_wa成员
2 天前 评论:

/lgtm
/approve

likedislike
ascend-robotascend-robot成员
2 天前 添加了label:approvedlgtm
ascend-robotascend-robot成员
2 天前 关闭了关联的issue
ascend-robotascend-robot成员
2 天前 合入了pull request
ascend-robot
ascend-robot成员
2 天前 评论:

Pull Request 已合并或已关闭。

If you want to solve this problem, you can click here to do it in the FAQs.

likedislike