已合并
[Doc] [bugfix]文档 CLI 参数规范化:统一为新命令行规范并补充 --version 参考 #887
chenruijie创建于 3 天前
[Doc] [bugfix]文档 CLI 参数规范化:统一为新命令行规范并补充 --version 参考 #887
已合并
chenruijie创建于 3 天前
chenruijie成员
3 天前

PR 提交说明

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

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

1. 影响面评估

接口变更(按需):

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

输出件变更(按需):

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

非兼容变更(按需):

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

SIG 评审结论(按需):

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

2. 修改描述

**修改背景(可选):**部分文档的参数示例扔采用旧版规范,cli文档中缺失新增的--version/-V 命令相关介绍

修改目的: 使修改后的文档描述符合新版CLI参数规范,并新增--version/-V 命令相关介绍

修改内容:

• doc(CLI 参数规范化):统一文档中的 CLI 参数写法为新规范,包括 --config(替代 --config_path)、布尔参数小写 true/false、--device 与 --device_id 职责拆分。
• 例:docs/zh/user_guide/usage_quick_quantization.md、docs/en/feature_guide/quick_quantization_v1/usage.md、docs/en/getting_started/quantization_quick_start.md 等一键量化 / 快速开始文档
• doc(新增 --version 参考):在 CLI 文档中补充新增的 --version/-V 命令介绍。
• 例:docs/zh/api_reference/cli/msmodelslim_quant.md、docs/zh/api_reference/cli/msmodelslim_analyze.md、docs/zh/api_reference/cli/msmodelslim_tune.md
• doc(--timeout / --device 参数描述修正):将 --timeout 规范为整数秒(兼容遗留时长字符串);修正 --device 多卡参数描述(设备类型用 --device,多卡索引用 --device_id 指定)。
• 例:docs/zh/user_guide/usage_auto_precision_tuning.md、docs/en/feature_guide/auto_precision_tuning/usage.md、docs/zh/knowledge_base/ptq/{llm,vlm,dit}/usage_*.md
• doc(Wan2.2 新模型量化文档修复):修复 Wan2.2 新模型量化文档不合理内容。
• 例:docs/zh/best_practices/wan2_2_w4a4f4_new_dit_quantization_case.md、docs/zh/user_guide/usage_weight_quantization.md
• doc(format 量化格式资料修复):修复 ascendv1 / compressed_tensors / mindie_sd 等量化格式文档 issue。
• 例:docs/zh/knowledge_base/quantization_format/ascendv1/ascendv1_usage.md、docs/zh/knowledge_base/quantization_format/compressed_tensors/compressed_tensors_usage.md、docs/zh/knowledge_base/quantization_format/mindie_sd/mindie_sd_usage.md

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

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

3. 功能验证

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

复现步骤(可选):

# 在此粘贴可复现命令

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

典型安全编码问题

DT

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 chenruijie 的贡献)
Cchenruijie成员
3 天前 关联了issue:[Doc]:【资料测试】命令行参数变更,资料需要同步修改,资料扔存在部分参数使用旧的用法
ascend-robot
ascend-robot成员
3 天前 评论:

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
3 天前 添加了label:docs-ci-pipeline-running
Cchenruijie成员
3 天前 推送  7 个提交:d3af0e30-6 commits from branch master26ff33a9-Merge remote-tracking branch 'upstream/master' into docs-fix
此处折叠了64条消息 查看更多
AtlasAccount
AtlasAccount成员
2 天前 评论:
流水线 PR-pipeline_msmodelslim#2418 [ commitID:dc2920fa ] 已完成
>>>代码风格自动修复执行失败,具体请查看日志,不影响流水线执行及PR合入
阶段 任务名 状态 详情
编译构建 Build_msmodelslim ⚪ IGNORED >>>
恶意代码检查 Antipoison_MindStudio-ModelSlim ⚪ IGNORED >>>
编码安全与规范检查 codecheck_pre-commit ⚪ IGNORED >>>
md_check md_check ✅ COMPLETED >>>
pre-commit ⚪ IGNORED >>>
开源片段检查 SCA_MindStudio-ModelSlim ⚪ IGNORED >>>
开发者测试 UT_msmodelslim ⚪ IGNORED >>>
PreSmoke_msmodelslim ⚪ IGNORED >>>
流水线 PR-pipeline_msmodelslim ✅ COMPLETED >>>
此流水线已支持下列评论快捷指令,仅PR创建者和白名单成员[A1streomeria, xyxin_006, libarry, joejoezhou, xiaoheng181, rookie_hongchuan]评论有效
  • compile : 运行流水线
  • retry : 重试流水线所有失败子任务
  • retry <任务名> : 仅重试指定失败子任务
  • stop : 停止流水线
likedislike
ascend-robotascend-robot成员
2 天前 合入了pull request
ascend-robot
ascend-robot成员
2 天前 评论:

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

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