已合并
[master][Doc] 删除冗余一键量化完整指南 usage_quick_quantization.md,内容迁移至 usage_one_click_quantization 附录、配置文档与各使用指南 #997
[master][Doc] 删除冗余一键量化完整指南 usage_quick_quantization.md,内容迁移至 usage_one_click_quantization 附录、配置文档与各使用指南 #997
已合并
tanxiangyuu创建于 28 天前
tanxiangyuu
tanxiangyuu成员
28 天前

PR 提交说明

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

PR 标题前缀:[Doc](与 CONTRIBUTING 一致)

1. 影响面评估

接口变更(按需): 无

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

输出件变更(按需): 无

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

非兼容变更(按需): 无

备注:删除的 usage_quick_quantization.md 全部内容均已迁移至对应载体,无信息丢失。

SIG 评审结论(按需): 无

2. 修改描述

同步说明: 本 PR 为 master PR #997 的同步(cherry-pick 提交 7e807320),将「删除冗余一键量化完整指南并迁移内容」同步至 26.2.0 分支。
修改背景(可选): docs/zh/user_guide/ 下存在两篇一键量化文档(usage_quick_quantization.md《一键量化完整指南》与 usage_one_click_quantization.md《一键量化使用指南》),内容重叠冗余。为避免文档重复维护与入口混乱,删除冗余的《一键量化完整指南》;删除前逐节确认其全部内容在其他文档中均有载体(本次迁移 + 既有载体),并完成全部引用重映射。

修改目的: 统一一键量化文档入口为 usage_one_click_quantization.md;确保 usage_quick_quantization.md 删除后无任何内容丢失,且所有内容均有可追溯的承载文档链接。

修改内容:(按「概念 - 变化」分条)

  • docs/user_guide:删除 usage_quick_quantization.md;usage_one_click_quantization.md 末尾新增 ## 12. 附录 > ### 12.1 协议版本维护策略
  • docs/api_reference/cli:msmodelslim_quant.md §4 参数关系新增「最佳实践匹配搜索优先级」1-6
  • docs/api_reference/config/task:modelslim_v1.md §1 补充 modelslim_v1 相对 modelslim_v0 的三条优势
  • docs/knowledge_base/parallel:README.md §3 新增 dp_layer_wise 算法名视角支持列表;data_parallelism_guide.md §10 补充校准集大小、算法支持说明
  • docs/knowledge_base/ptq:LLM 量化指南 步骤5 补充调度器选型对照/适用场景/工作原理与优势对比/选型建议;VLM 量化指南 步骤2 后新增 <span id="dataset---校准数据路径配置"> 校准数据路径配置(参考)
  • example:multimodal_sd/Wan2_2/README.md 补充 3 个 wan2_2 yaml 链接、multimodal_vlm/Qwen3-VL-MoE/README.md 补充 qwen3_vl_moe_w8a8.yaml 链接
  • 引用重映射:88 个文件指向 usage_quick_quantization.md 的链接(含锚点)全部重定向至新载体;导航入口(mkdocs.yml、docs/zh/user_guide/README.md、根 README.md)切换至 usage_one_click_quantization.md
  • 链接校验:改动覆盖的 92 个文件无新增 broken 链接

概念域参考:

  • cli:msmodelslim quant 命令格式 / 参数列表 / 使用示例 / 最佳实践匹配优先级
  • app:一键量化使用指南(前置条件、操作步骤、交付件校验、协议版本维护策略)
  • core:runner / processor / save / dataset 配置详解,逐层量化与分布式逐层量化
  • infra:lab_practice 最佳实践 YAML、示例仓库 README 相关资源

被删文档内容承载映射(docs/zh/user_guide/usage_quick_quantization.md )

被删文档章节 内容承载位置 链接
§1 简介(一键量化概述、两种使用方式) 一键量化使用指南 全文(入口统一);CLI §1 功能说明(quant_type/config 两种配置来源) usage_one_click_quantization.md、msmodelslim_quant.md
§2 使用前准备(安装) 安装指南;一键量化使用指南 §2 流程关系与前置条件 install_guide.md、usage_one_click_quantization.md
§3.1 命令格式 CLI §2 命令格式 msmodelslim_quant.md
§3.1 最佳实践搜索优先级 CLI §4 参数关系「最佳实践匹配搜索优先级」1-6 msmodelslim_quant.md
§3.2 参数说明 CLI §3 参数列表(原 #32-参数说明 引用已全部重映射至此) msmodelslim_quant.md
§3.3 使用示例(示例1/2/3) CLI §7 使用示例(默认量化类型 / 自定义配置 / 多卡分布式) msmodelslim_quant.md
§3.4 输出说明 一键量化使用指南 §3 输入和交付件、§5 步骤7 校验交付件 usage_one_click_quantization.md
§4.1.1 逐层量化简介 并行机制 README §1/§2 并行机制简述 parallel/README.md
§4.1.2 适用场景 LLM 量化指南 步骤5 适用场景表 usage_large_language_model_quantization.md
§4.1.3 工作原理与优势对比 LLM 量化指南 步骤5 工作原理与优势对比表 usage_large_language_model_quantization.md
§4.1.4 配置方法(runner / 单卡 / 多卡) LLM 量化指南 步骤5 runner 配置;并行 README §4 多卡量化配置与使用;一键量化使用指南 步骤5/6 usage_large_language_model_quantization.md、parallel/README.md、usage_one_click_quantization.md
§4.1.5 注意事项 DP 指南 §10 产品形态与资源限制(校准集大小、算法支持);VLM 指南 步骤2 多模态 runner 支持说明 data_parallelism_guide.md、usage_vision_transformer_quantization.md
§4.1.6 模型适配 并行 README §3 模型适配器支持列表;大模型支持矩阵 parallel/README.md、model/README.md
§4.1.7 算法适配 并行 README §3 dp_layer_wise 算法名视角支持列表 parallel/README.md
§5.1.1 量化配置协议基本结构 modelslim_v1 / multimodal_vlm_modelslim_v1 / multimodal_sd_modelslim_v1 配置详解 modelslim_v1.md、multimodal_vlm_modelslim_v1.md、multimodal_sd_modelslim_v1.md
§5.1.2 协议版本说明 一键量化使用指南 §12 附录 12.1 协议版本维护策略 usage_one_click_quantization.md
§5.2 modelslim_v1 配置详解(5.2.1-5.2.7) modelslim_v1 配置详解全文(§1 功能说明补充 v0→v1 三条优势) modelslim_v1.md
§5.3 multimodal_sd_modelslim_v1 配置详解(5.3.1-5.3.7) multimodal_sd_modelslim_v1 配置详解全文;§5.3.7 使用示例 yaml → Wan2_2 示例 README 相关资源 multimodal_sd_modelslim_v1.md、example/multimodal_sd/Wan2_2/README.md
§5.4 multimodal_vlm_modelslim_v1 配置详解(5.4.1-5.4.7) multimodal_vlm_modelslim_v1 配置详解全文;§5.4.6 dataset 校准数据路径配置 → VLM 指南新增锚点;§5.4.7 使用示例 yaml → Qwen3-VL-MoE 示例 README 相关资源 multimodal_vlm_modelslim_v1.md、usage_vision_transformer_quantization.md#dataset---校准数据路径配置、example/multimodal_vlm/Qwen3-VL-MoE/README.md
§5.5 modelslim_v0 配置说明 删除(v0 协议即将废弃,不推荐使用;策略见附录 12.1) —
§6.1 相关资料 量化算法 README(V1 架构支持算法);并行 README(逐层量化);示例 README 相关资源 quantization_algorithms/README.md、parallel/README.md
§6.2 常见问题(Q1-Q5) Q1-Q3 调度器选型/逐层量化判断 → LLM 指南 步骤5 选型建议;Q4 多卡加速 → DP 指南 §10;Q5 精度调优 → 量化精度调优指导 usage_large_language_model_quantization.md、data_parallelism_guide.md、process_quantization_precision_tuning.md

3. 功能验证

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

复现步骤(可选):

# 链接校验(仓库根目录)
git grep -n "usage_quick_quantization"  # 期望无输出

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

典型安全编码问题

DT

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 tanxiangyuu 的贡献)
tanxiangyuutanxiangyuu成员
28 天前 创建了 pull request,commit 6614bcb0
atomgit-bot
atomgit-bot
28 天前 评论:

变更摘要

本 PR 属于文档整理类变更:删除 docs/zh/user_guide/ 下冗余的《一键量化完整指南》usage_quick_quantization.md,并将其中内容按主题迁移到一键量化主文档、API 参考、知识库与示例等既有载体,同时更新导航入口与全仓引用。迁移内容包括协议版本维护策略、最佳实践匹配优先级、校准数据路径配置、LLM 调度器与选型建议、校准集与算法支持说明、算法适配表、modelslim_v0→modelslim_v1 优势说明以及多模态示例 yaml,其中 modelslim_v0 附录直接删除。mkdocs.yml 中的一键量化使用指南条目由 usage_quick_quantization.md 改为 usage_one_click_quantization.md。


主要改动

  • 导航入口切换: mkdocs.yml 中「一键量化 (V1) - 使用指南」的链接由 zh/user_guide/usage_quick_quantization.md 改为 zh/user_guide/usage_one_click_quantization.md,docs/zh/user_guide/README.md 与根 README.md 的入口同步指向新载体。
  • 删除冗余文档并迁移正文: 移除 usage_quick_quantization.md,其协议版本维护策略迁移为 usage_one_click_quantization.md 的 ## 12. 附录 > ### 12.1 协议版本维护策略,modelslim_v0 附录内容(§5.5)直接删除。
  • 配置与 API 参考补充: 最佳实践匹配优先级迁入 api_reference/cli/msmodelslim_quant.md §4,modelslim_v0→v1 三条优势迁入 api_reference/config/task/modelslim_v1.md §1。
  • 知识库内容承接: 校准数据路径配置、LLM 调度器/适用场景/原理对比/选型建议、校准集与算法支持说明、算法适配表分别迁入 usage_vision_transformer_quantization.md、usage_large_language_model_quantization.md 步骤 5、data_parallelism_guide.md §10 与 knowledge_base/parallel/README.md §3。
- **引用重映射与示例补充**: 88 个文件中指向 `usage_quick_quantization.md` 的链接全部重映射到新载体(含锚点级映射),多模态示例 `yaml` 迁入 `example/multimodal_sd/Wan2_2/README.md` 与 `example/multimodal_vlm/Qwen3-VL-MoE/README.md`。
likedislike
不准确?
atomgit-bot
atomgit-bot
28 天前 评论:

代码审查

✅ 未发现问题

likedislike
不准确?
ascend-robotascend-robot成员
28 天前 添加了label:ascend-cla/yes
此处折叠了190条消息 查看更多
LeeQT成员
7 天前 评论:

/lgtm

likedislike
ascend-robotascend-robot成员
7 天前 添加了label:lgtm
LeeQT成员
7 天前 评论:

/approve

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