Merged
[Doc] 修复 issue 528 part.1(cli 和 config 文档问题及相关引用更新) #1021
jiamingxuAdd on Sep 24
[Doc] 修复 issue 528 part.1(cli 和 config 文档问题及相关引用更新) #1021
Merged
Merged fromjiamingxuaa/msmodelslimmasterintoAscend/msmodelslimmaster
Pull Request has been successfully merged by ascend-robot.
(Thank you for jiamingxu's contribution.)atomgit-bot
Sep 24 Comments:
Sep 24 Comments:
变更摘要
本 PR 为文档与导航重构,针对 issue 528 的反馈理顺 cli 与 config 文档层级,未改动运行时代码。主要工作包括:新增 api_reference/cli/README.md 汇总全局/公共参数与子命令,校准 quant / analyze / eval / tune 参数表、互斥关系、权重转换省略 --model_type、--save_path 公共化及 tags 示例等表述;在 docs/api_reference/config 下新增手写导航 config/README.md、config/quant/README.md、config/tuning/README.md,将任务配置目录 task/ 重命名为 quant/,删除手写页 auto_precision_tuning.md,并把组合处理器说明迁移至 user_guide/usage_processor_group.md;同步更新生成页字段说明、全库交叉链接与文档生成约定。
主要改动
- CLI 文档导航与参数校准: 新增
api_reference/cli/README.md作为全局/公共参数与子命令总览入口,并校准quant/analyze/eval/tune的参数表、互斥关系、权重转换省略--model_type、--save_path公共化及 tags 示例等表述。 - 配置文档目录与导航重构: 在
docs/api_reference/config下新增手写导航config/README.md、config/quant/README.md、config/tuning/README.md,将任务配置目录task/重命名为quant/,形成“先选协议、再按 type 查处理器”的组织方式。 - 文档迁移与删除: 删除手写长文
config/auto_precision_tuning.md,其内容由config/tuning/README.md与既有tuning/*字段页承接;组合处理器说明迁移至user_guide/usage_processor_group.md。 - 生成页字段说明更新: 更新
processor/*、format/*、tuning/*及quant/*等生成页的字段说明与结构,涉及modelslim_convert、evaluation_service_oriented、group、trainable_linear_quant等字段。 - 交叉引用与文档生成约定同步: 批量将
config/task/链接改为config/quant/,并更新api_reference_docgen.md与脚本 README,明确quant/产出目录、手写README.md受MANUAL_KEEP保护、配置块编号最多 3 段等约定。


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


Incorrect?
93 messages are collapsed here。 See more
Sep 24 Added label: ci-pipeline-running
Sep 24 Removed label: ci-pipeline-running
Sep 24 Added label: ci-pipeline-passed
AtlasAccount
Sep 24 Comments:
Sep 24 Comments:
流水线 PR-pipeline_msmodelslim#2686 [ commitID:6dc5fbdd ] 已完成
>>>代码风格自动修复执行成功(无修复内容)
| 阶段 | 任务名 | 状态 | 详情 |
|---|---|---|---|
| 编译构建 | Build_msmodelslim | ✅ COMPLETED | >>> |
| 恶意代码检查 | Antipoison_MindStudio-ModelSlim | ✅ COMPLETED | >>> |
| 编码安全与规范检查 | codecheck_pre-commit | ✅ COMPLETED | >>> |
| md_check | md_check | ✅ COMPLETED | >>> |
| pre-commit | ✅ COMPLETED | >>> | |
| 开源片段检查 | SCA_MindStudio-ModelSlim | ✅ COMPLETED | >>> |
| 开发者测试 | UT_msmodelslim | ✅ COMPLETED | >>> |
| PreSmoke_msmodelslim | ✅ COMPLETED | >>> | |
| 流水线 | PR-pipeline_msmodelslim | ✅ COMPLETED | >>> |
- ci_pipeline : 运行流水线
- retry : 重试流水线所有失败子任务
- retry <任务名> : 仅重试指定失败子任务
- stop : 停止流水线


Sep 24 Merged pull request
PR 提交说明
提交前请阅读 贡献指南,开发者文档:模型接入指南
PR 标题前缀:[Feature]、[Bugfix]、[Doc]、[Test](与 CONTRIBUTING 一致)
1. 影响面评估
接口变更(按需): 无
输出件变更(按需): 无
非兼容变更(按需):
文档路径调整(书签/外链需迁移)
docs/zh/api_reference/config/task/→docs/zh/api_reference/config/quant/docs/zh/api_reference/config/auto_precision_tuning.md,改由config/tuning/README.md+ 既有tuning/*字段页承接docs/zh/api_reference/config/processor_group.md→docs/zh/user_guide/usage_processor_group.md迁移:将旧链接中的
config/task/改为config/quant/;自动调优协议说明改链至config/tuning/README.md;组合处理器用法改链至user_guide/usage_processor_group.md。仓库内交叉引用已同步更新。SIG 评审结论(按需): 无
2. 修改描述
修改背景(可选):
API Reference 中配置文档按类型组织,缺少统一的“先选协议 / 再按 type 查处理器”导航;CLI 与配置字段说明、示例标签等与现状不完全一致;自动调优手写长文与
tuning/生成页并存,入口分散;以及测试提出的各种修改建议。修改目的:
理顺
cli/config文档层级与导航,校准命令行与配置字段说明,并同步全库交叉链接与文档生成约定,降低查阅与后续维护成本。修改内容:
api_reference/cli/README.md(全局/公共参数、子命令总览);校准quant/analyze/eval/tune参数表、互斥关系、权重转换省略--model_type、--save_path公共化、tags 示例等表述config/README.md、config/quant/README.md、config/tuning/README.md;任务配置目录task/重命名为quant/;删除auto_precision_tuning.md;组合处理器说明迁至user_guide/usage_processor_group.mdprocessor/*、format/*、tuning/*及quant/*字段说明/结构(如modelslim_convert、evaluation_service_oriented、group、trainable_linear_quant等)config/task/链接改为config/quant/,并同步自动调优/组合处理器相关入口api_reference_docgen.md与脚本 README,明确quant/产出目录、手写README.md受MANUAL_KEEP保护、配置块编号最多 3 段等约定概念域参考(填写提示):
说明:本 PR 为文档与导航重构,未改动 app / core / infra / utils 运行时代码;修改内容主要落在 cli(文档) 与文档体系本身。
3. 功能验证
冒烟由 CI 门禁检查,无需填写「冒烟是否通过」。
复现步骤(可选):
# 在此粘贴可复现命令4. 自检(请逐项确认,不适用标 N/A)
典型安全编码问题
DT