已合并
[Doc] 补全权重转换 CLI/YAML/多卡说明并纠正知识库结构 #956
[Doc] 补全权重转换 CLI/YAML/多卡说明并纠正知识库结构 #956
已合并
chenruijie创建于 9月14日
chenruijie成员
9月14日

PR 提交说明

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

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

建议标题: [Doc] 补全权重转换 YAML/CLI/多卡说明并纠正知识库结构

1. 影响面评估

接口变更(按需): 无

仅文档与示例 YAML 注释/落盘格式写法;不改 CLI 参数、API、运行时 YAML schema。

输出件变更(按需): 无

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

非兼容变更(按需): 无

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

SIG 评审结论(按需): 无

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

2. 修改描述

修改背景(可选): issue #534:权重转换的 YAML 配置、使用说明、config 介绍、知识库整体结构与多卡机制存在多处资料问题(约 18 处)。表现为:转换命令不可直接复制、--model_type/--quant_type 与量化路径混写、save.type 别名过多、defaults 与 save 优先级不清、量化 DP/EP/DTS 被误套到 convert、PTQ 接入指南缺权重转换入口。

修改目的: 按现网 convert 实现补全用户侧资料:给出可复制命令与示例 YAML,写清用户真正要调的配置,划清量化多卡与权重转换并行方案,并保持与 master 词条/可调参数口径一致。

修改内容:

  • docs/cli:msmodelslim quant 增加权重转换示例(§7.6);写明转换不需要 --model_type / --quant_type;NPU 多卡示例为 --device npu --device_id 0 1 2 3。
  • docs/config:modelslim_convert 配置页修正 apiversion 固定为 modelslim_convert(不再展示基类占位 Unknown 及其他任务取值);明确 defaults.dst_format 与 spec.save 的覆盖关系(配了 save 不走 defaults);日常保存格式只写 huggingface / ascend_v1;并行只区分 CPU workers 与 NPU --device_id,保留用户可调的 max_group_size(MoE 切组防拖尾),使用指南调参表隐去日常不改的 linears.route。
  • docs/ptq:使用指南补 INT4 路径、可点击示例 YAML、可复制转换命令与多卡命令;步骤 4 聚焦 match / target / save / workers / max_group_size。PTQ 知识库接入指南补权重转换行(配置驱动、无需模型适配器)。术语词条保留 master 原有机制说明(虚拟模块树、tick-tock、7 阶段流水线等),仅规范保存格式名与 NPU/CPU 设备口径。
  • docs/parallel:文首与使用说明写明本目录只覆盖量化多卡(DP / EP / DTS),不覆盖 convert;convert 走自身并行方案,入口见权重转换使用指南。
  • docs/knowledge_base:ptq 入口改为 ptq/README.md,避免误链到转换使用页。

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

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

3. 功能验证

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

复现步骤(可选):

文档核对(无运行时行为变更)。对照页:

  • docs/zh/knowledge_base/ptq/convert/usage_weight_conversion.md
  • docs/zh/api_reference/cli/msmodelslim_quant.md §7.6
  • docs/zh/api_reference/config/task/modelslim_convert.md
  • docs/zh/knowledge_base/ptq/README.md
  • docs/zh/knowledge_base/parallel/README.md
# 仅文档变更,无功能复现命令

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

典型安全编码问题

DT

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 chenruijie 的贡献)
Cchenruijie成员
9月14日 创建了 pull request,commit 66328d96
atomgit-bot
atomgit-bot
9月14日 评论:

变更摘要

该 PR 为纯文档变更([Doc]),核心目标是补全权重转换功能的使用说明,并纠正知识库的文档结构。根据 PR 描述,本次变更不涉及 CLI、API、YAML 等接口变更,也无输出件及非兼容变更;内容主要围绕权重转换相关文档的 CLI 命令行说明、YAML 配置说明与多卡(多设备)场景说明的补充完善,同时对知识库的文档组织结构进行了调整纠正。

主要改动

  • 补全权重转换 CLI 说明: 完善权重转换场景下命令行工具的用法、参数及操作步骤说明。
  • 补全权重转换 YAML 说明: 补充权重转换涉及的 YAML 配置文件字段含义与配置方法说明。
  • 补全多卡说明: 增加多卡(多设备)环境下执行权重转换的相关说明。
  • 纠正知识库结构: 调整知识库文档的目录归类与组织方式,修正文档间的结构与引用关系。
likedislike
不准确?
atomgit-bot
atomgit-bot
9月14日 评论:

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

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

Pull Request 已合并或已关闭。

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

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

✅ 跳过 docs ci 检查,没有需要检查的文档文件

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

Pull Request 已合并或已关闭。

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

likedislike