| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
[Doc] 优化接口文档：配置文档源码自动生成与结构重组，接口文档按检视整改 Co-authored-by: rookie_hongchuan<hongchuan6@h-partners.com> # message auto-generated for no-merge-commit merge: !845 merge docs/optimize-api-reference into master [Doc] 优化接口文档：配置文档源码自动生成与结构重组，接口文档按检视整改 Created-by: rookie_hongchuan Commit-by: rookie_hongchuan Merged-by: ascend-robot Description: # PR 提交说明 提交前请阅读 [贡献指南](https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/contributing_guide.md)，开发者文档：[模型接入指南](../docs/zh/knowledge_base/model/integrating_models.md) PR 标题前缀：[Feature]、[Bugfix]、[Doc]、[Test]（与 CONTRIBUTING 一致） ## 1. 影响面评估 **接口变更（按需）：** 无。仅文档与文档生成脚本调整，不改动 CLI/API/YAML 解析与量化运行时行为。 > 备注：CLI 文档（模板 05）为手工维护、对照实现与 --help 撰写，本 PR 不改变任何命令行行为。 **输出件变更（按需）：** 无 > 备注：不涉及导出格式、产物路径等。 **非兼容变更（按需）：** 无 **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} 语法。 - **源码注解补齐并重新生成**：为各配置类补全/修正类 docstring、Field(description=)、validator docstring 并同步重新生成全部配置文档；修正评估服务校验器路径描述（evaluation.datasets）等。 - **CLI 文档补齐**：新增/完善 docs/zh/api_reference/cli/msmodelslim_{quant,analyze,tune}.md（模板 05），修正参数默认值、条件必选、行为描述等。 - **规范与模板同步**：更新量化配置文档模板与校验清单、生成器设计文档、资料规范 README、docs-management skill 场景文档；回退 CLI 文档模板中与上游不一致的编号说明。 - **检视整改**：按检视意见修复术语（敏感性/敏感度、落盘、回退 等）、表格矛盾（默认值/取值范围/必选）、路径错误、Markdown 格式问题（MD038/MD031/MD051）等。 - **pre-commit 门禁修复**：ruff 格式重排、日志惰性格式化（W1202/W1203）、pylint/bandit 豁免、typos 变量改名、codespell 白名单补充 TE；MR 全量变更文件通过 pre-commit。 **概念域参考（填写提示）：** - cli：本 PR 仅文档，不改 CLI 代码 - docs：配置/CLI 接口文档、资料规范与模板 - skills：docs-management 文档生成 skill ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验：生成器 --check 无 drift；py_compile 通过；MR 全量 106 个变更文件通过 pre-commit（ruff / codespell / pylint / bandit / typos）。 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） **复现步骤（可选）：** bash python3 skills/docs-management/scripts/gen_config_api_docs.py --check ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据 N/A - [x] 是否未采集或打印敏感信息 - [x] 是否已正确设置文件权限 N/A - [x] 是否充分考虑浮点运算溢出、除零等异常场景 N/A - [x] 是否已对正则表达式做 ReDos 检查 N/A **DT** - [x] 是否具备 UT 测试用例看护：否（生成脚本不保留单测，正确性由 --check 与文档门禁校验兜底） - [x] 是否需要添加冒烟：否（文档生成与描述修复，不改变量化运行时行为） See merge request: Ascend/msmodelslim!845 | 2 个月前 | |
[Doc] 优化接口文档：配置文档源码自动生成与结构重组，接口文档按检视整改 Co-authored-by: rookie_hongchuan<hongchuan6@h-partners.com> # message auto-generated for no-merge-commit merge: !845 merge docs/optimize-api-reference into master [Doc] 优化接口文档：配置文档源码自动生成与结构重组，接口文档按检视整改 Created-by: rookie_hongchuan Commit-by: rookie_hongchuan Merged-by: ascend-robot Description: # PR 提交说明 提交前请阅读 [贡献指南](https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/contributing_guide.md)，开发者文档：[模型接入指南](../docs/zh/knowledge_base/model/integrating_models.md) PR 标题前缀：[Feature]、[Bugfix]、[Doc]、[Test]（与 CONTRIBUTING 一致） ## 1. 影响面评估 **接口变更（按需）：** 无。仅文档与文档生成脚本调整，不改动 CLI/API/YAML 解析与量化运行时行为。 > 备注：CLI 文档（模板 05）为手工维护、对照实现与 --help 撰写，本 PR 不改变任何命令行行为。 **输出件变更（按需）：** 无 > 备注：不涉及导出格式、产物路径等。 **非兼容变更（按需）：** 无 **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} 语法。 - **源码注解补齐并重新生成**：为各配置类补全/修正类 docstring、Field(description=)、validator docstring 并同步重新生成全部配置文档；修正评估服务校验器路径描述（evaluation.datasets）等。 - **CLI 文档补齐**：新增/完善 docs/zh/api_reference/cli/msmodelslim_{quant,analyze,tune}.md（模板 05），修正参数默认值、条件必选、行为描述等。 - **规范与模板同步**：更新量化配置文档模板与校验清单、生成器设计文档、资料规范 README、docs-management skill 场景文档；回退 CLI 文档模板中与上游不一致的编号说明。 - **检视整改**：按检视意见修复术语（敏感性/敏感度、落盘、回退 等）、表格矛盾（默认值/取值范围/必选）、路径错误、Markdown 格式问题（MD038/MD031/MD051）等。 - **pre-commit 门禁修复**：ruff 格式重排、日志惰性格式化（W1202/W1203）、pylint/bandit 豁免、typos 变量改名、codespell 白名单补充 TE；MR 全量变更文件通过 pre-commit。 **概念域参考（填写提示）：** - cli：本 PR 仅文档，不改 CLI 代码 - docs：配置/CLI 接口文档、资料规范与模板 - skills：docs-management 文档生成 skill ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验：生成器 --check 无 drift；py_compile 通过；MR 全量 106 个变更文件通过 pre-commit（ruff / codespell / pylint / bandit / typos）。 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） **复现步骤（可选）：** bash python3 skills/docs-management/scripts/gen_config_api_docs.py --check ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据 N/A - [x] 是否未采集或打印敏感信息 - [x] 是否已正确设置文件权限 N/A - [x] 是否充分考虑浮点运算溢出、除零等异常场景 N/A - [x] 是否已对正则表达式做 ReDos 检查 N/A **DT** - [x] 是否具备 UT 测试用例看护：否（生成脚本不保留单测，正确性由 --check 与文档门禁校验兜底） - [x] 是否需要添加冒烟：否（文档生成与描述修复，不改变量化运行时行为） See merge request: Ascend/msmodelslim!845 | 2 个月前 | |
[Doc] 修复 issue 528 part.1（cli 和 config 文档问题及相关引用更新） Co-authored-by: jiamingxuaa<xujiaming19@h-partners.com> # message auto-generated for no-merge-commit merge: !1021 merge master into master [Doc] 修复 issue 528 part.1（cli 和 config 文档问题及相关引用更新） Created-by: jiamingxuaa Commit-by: jiamingxuaa Merged-by: ascend-robot Description: # PR 提交说明 提交前请阅读 [贡献指南](https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/contributing_guide.md)，开发者文档：[模型接入指南](../docs/zh/knowledge_base/model/integrating_models.md) PR 标题前缀：[Feature]、[Bugfix]、[Doc]、[Test]（与 CONTRIBUTING 一致） ## 1. 影响面评估 **接口变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及 CLI、API、YAML 等请在此项补充说明。 **输出件变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及导出格式、产物路径等请在此项补充说明。 **非兼容变更（按需）：** 文档路径调整（书签/外链需迁移） - 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 评审结论（按需）：** 无 > 提醒：非兼容、安全风险等高危 PR 须经 SIG 评审后合入；无则保留「无」。 ## 2. 修改描述 **修改背景（可选）：** API Reference 中配置文档按类型组织，缺少统一的“先选协议 / 再按 type 查处理器”导航；CLI 与配置字段说明、示例标签等与现状不完全一致；自动调优手写长文与 tuning/ 生成页并存，入口分散；以及[测试提出的各种修改建议](https://gitcode.com/Ascend/msmodelslim/issues/528)。 **修改目的：** 理顺cli / config 文档层级与导航，校准命令行与配置字段说明，并同步全库交叉链接与文档生成约定，降低查阅与后续维护成本。 **修改内容：** - 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/；删除 auto_precision_tuning.md；组合处理器说明迁至 user_guide/usage_processor_group.md - docs/api_reference/config（生成页）：更新 processor/*、format/*、tuning/* 及 quant/* 字段说明/结构（如 modelslim_convert、evaluation_service_oriented、group、trainable_linear_quant 等） - docs/knowledge_base & user_guide & skills：批量将 config/task/ 链接改为 config/quant/，并同步自动调优/组合处理器相关入口 - docs/contributing & skills/docs-management：更新 api_reference_docgen.md 与脚本 README，明确 quant/ 产出目录、手写 README.md 受 MANUAL_KEEP 保护、配置块编号最多 3 段等约定 **概念域参考（填写提示）：** 说明：本 PR 为文档与导航重构，未改动 app / core / infra / utils 运行时代码；修改内容主要落在 cli（文档） 与文档体系本身。 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [ ] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） **复现步骤（可选）：** bash # 在此粘贴可复现命令 ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [ ] 是否已校验外部数据 - [x] 是否未采集或打印敏感信息 - [ ] 是否已正确设置文件权限 - [ ] 是否充分考虑浮点运算溢出、除零等异常场景 - [ ] 是否已对正则表达式做 ReDos 检查 **DT** - [ ] 是否具备 UT 测试用例看护（路径：用例路径；未添加请说明原因） - [x] 是否需要添加冒烟：否（若「是」请说明冒烟场景及对应用途） See merge request: Ascend/msmodelslim!1021 | 1 个月前 |
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 2 个月前 | ||
| 2 个月前 | ||
| 1 个月前 |