已合并
[Doc] 优化接口文档:配置文档源码自动生成与结构重组,接口文档按检视整改 #845
rookie_hongchuan创建于 21 天前
[Doc] 优化接口文档:配置文档源码自动生成与结构重组,接口文档按检视整改 #845
已合并
Pull Request已成功合入, 合并人@ascend-robot
(感谢 rookie_hongchuan 的贡献)atomgit-bot
21 天前 评论:
21 天前 评论:
变更摘要
本 PR 解决接口层文档(模板 04/05)靠手工维护、与实现易漂移的问题:新增一套基于源码的文档生成器,从 argparse 定义生成命令行 API 文档、从 Pydantic JSON Schema 生成量化配置接口文档,并支持 --check 漂移检测。为此在 msmodelslim/cli/__main__.py 中将 main() 拆出 build_parser(),让文档生成与运行时共用同一棵 argparse 树,命令行行为保持不变;生成结果输出到 docs/zh/api_reference/cli/ 与 docs/zh/api_reference/config/,同时自动更新 mkdocs.yml 导航并补充生成器设计说明。
主要改动
- CLI 解析器抽取:
msmodelslim/cli/__main__.py新增build_parser()并返回 argparse 解析树,main()改为调用它后再处理参数,使文档生成与运行时共用同一份命令行定义,CLI 行为不变。 - 命令行文档生成器: 新增
docs/scripts/cli_docgen.py(渲染层,含ArgRecord、CommandRecord、render_cli_markdown等)与docs/scripts/gen_cli_docs.py(入口,含collect_commands、build_command_record、update_mkdocs),从 argparse 抽取类型、必选/可选、默认值、约束、scope 专有参数、配置引用、环境变量、退出码与安全说明,生成 quant/analyze/tune 三个子命令文档并支持--check与--dry-run。 - 量化配置文档生成器: 新增
docs/scripts/quant_config_docgen.py(通过DocJsonSchemaGenerator生成文档用 JSON Schema,含ModelRecord、extract_fields、render_markdown等)与docs/scripts/gen_quant_config_docs.py(含build_records、_yaml_paths、_wrap_example、update_mkdocs),从 Pydantic 模型注解抽取字段、约束与校验器文档,生成任务配置/服务规格/处理器/保存格式/嵌套配置文档与索引,支持--check漂移检测。 - MkDocs 导航更新:
mkdocs.yml将「八、Python API」改为「八、接口文档」,加入由# BEGIN/END GENERATED CLI NAV与# BEGIN/END GENERATED QUANT CONFIG NAV标记的自动生成导航区块(cli 三个子命令及量化配置文档树),生成器可据此自动更新。 - 单元测试补充: 新增
docs/scripts/test_cli_docgen.py与docs/scripts/test_quant_config_docgen.py,用不依赖msmodelslim的最小 argparse/Pydantic 模型覆盖参数抽取、语法构建、Markdown 渲染、内部 type 重写等逻辑。


不准确?
AtlasAccount
21 天前 评论:
21 天前 评论:
atomgit-bot
21 天前 评论:
21 天前 评论:
rookie_hongchuan
21 天前 评论:
21 天前 评论:
compile


21 天前 添加了label:ascend-cla/yes
此处折叠了288条消息 查看更多
19 天前 添加了label:ci-pipeline-passed
AtlasAccount
19 天前 评论:
19 天前 评论:
流水线 PR-pipeline_msmodelslim#2296 [ commitID:7edb0e5f ] 已完成
>>>代码风格自动修复执行成功(无修复内容)
| 阶段 | 任务名 | 状态 | 详情 |
|---|---|---|---|
| 编译构建 | Build_msmodelslim | ✅ | >>> |
| 恶意代码检查 | Antipoison_MindStudio-ModelSlim | ✅ | >>> |
| 编码安全与规范检查 | codecheck_pre-commit | ✅ | >>> |
| md_check | md_check | ✅ | >>> |
| pre-commit | ✅ | >>> | |
| 开源片段检查 | SCA_MindStudio-ModelSlim | ✅ | >>> |
| 开发者测试 | UT_msmodelslim | ✅ | >>> |
| PreSmoke_msmodelslim | ✅ | >>> | |
| 流水线 | PR-pipeline_msmodelslim | ✅ | >>> |
- compile : 运行流水线
- retry : 重试流水线所有失败子任务
- retry <任务名> : 仅重试指定失败子任务
- stop : 停止流水线


AtlasAccount
19 天前 评论:
19 天前 评论:
流水线 PR-pipeline_msmodelslim#2296 [ commitID:7edb0e5f ] 已完成
>>>代码风格自动修复执行成功(无修复内容)
| 阶段 | 任务名 | 状态 | 详情 |
|---|---|---|---|
| 编译构建 | Build_msmodelslim | ✅ | >>> |
| 恶意代码检查 | Antipoison_MindStudio-ModelSlim | ✅ | >>> |
| 编码安全与规范检查 | codecheck_pre-commit | ✅ | >>> |
| md_check | md_check | ✅ | >>> |
| pre-commit | ✅ | >>> | |
| 开源片段检查 | SCA_MindStudio-ModelSlim | ✅ | >>> |
| 开发者测试 | UT_msmodelslim | ✅ | >>> |
| PreSmoke_msmodelslim | ✅ | >>> | |
| 流水线 | PR-pipeline_msmodelslim | ✅ | >>> |
- compile : 运行流水线
- retry : 重试流水线所有失败子任务
- retry <任务名> : 仅重试指定失败子任务
- stop : 停止流水线


19 天前 合入了pull request
ascend-robot
19 天前 评论:
19 天前 评论:
Pull Request 已合并或已关闭。
If you want to solve this problem, you can click here to do it in the FAQs.


PR 提交说明
提交前请阅读 贡献指南,开发者文档:模型接入指南
PR 标题前缀:[Feature]、[Bugfix]、[Doc]、[Test](与 CONTRIBUTING 一致)
1. 影响面评估
接口变更(按需): 无。仅文档与文档生成脚本调整,不改动 CLI/API/YAML 解析与量化运行时行为。
输出件变更(按需): 无
非兼容变更(按需): 无
SIG 评审结论(按需): 无
2. 修改描述
修改背景: 接口层配置文档(模板 04)此前靠手工维护,新增处理器、改 Field 约束后容易与实现不一致;同时历史检视意见遗留若干文档问题(术语、表格矛盾、路径错误、Markdown 格式等)。
修改目的: 从源码自动生成量化配置接口文档并可用
--check防漂移;按 AI 检视意见整改文档与规范模板;修复 pre-commit 门禁问题,使 MR 全量变更文件通过检查。修改内容:
skills/docs-management/scripts/(gen_config_api_docs.py驱动 /gen_quant_config_docs.py装配 /quant_config_docgen.py渲染),从 Pydantic JSON Schema 抽取字段、默认值、约束与type分派,--check逐字节核对生成稿与源码是否漂移;生成稿带generated-by标记、不手工编辑。config/{task,processor,format,tuning}/分类子目录组织;task 与 spec 合并为一页、不再单独生成spec/页面;删除config/README.md索引;页内跳转统一使用 HTML 锚点(<h3 id>/<a href>),弃用{#anchor}语法。Field(description=)、validator docstring 并同步重新生成全部配置文档;修正评估服务校验器路径描述(evaluation.datasets)等。docs/zh/api_reference/cli/msmodelslim_{quant,analyze,tune}.md(模板 05),修正参数默认值、条件必选、行为描述等。敏感性/敏感度、落盘、回退等)、表格矛盾(默认值/取值范围/必选)、路径错误、Markdown 格式问题(MD038/MD031/MD051)等。TE;MR 全量变更文件通过 pre-commit。概念域参考(填写提示):
3. 功能验证
冒烟由 CI 门禁检查,无需填写「冒烟是否通过」。
复现步骤(可选):
4. 自检(请逐项确认,不适用标 N/A)
典型安全编码问题
DT