| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
[Bugfix] 修复 PR 800 词条文档类型命名与校验链接规范问题 Co-authored-by: joejoezhou<zhourongchen1@huawei.com> # message auto-generated for no-merge-commit merge: !815 merge feature/glossary-rename into master [Bugfix] 修复 PR 800 词条文档类型命名与校验链接规范问题 Created-by: joejoezhou Commit-by: joejoezhou Merged-by: ascend-robot Description: ## 1. 影响面评估 **接口变更：** 无（仅文档治理，不涉及 CLI/API/YAML） **输出件变更：** 无（纯资料规范修正；模板与校验清单文件更名，文档内引用随之更新） **非兼容变更：** 无 **SIG 评审结论：** 无（文档 PR，无安全风险） ## 2. 修改描述 **修改背景：** 修复 issue #453。PR 800（docs_standards 资料规范 + docs-management skill）合入后，词条相关文档存在文档类型命名不一致、链接与书名号违反自身规范（CE-05）、校验清单条目冗余/矛盾等问题；并需随主干演进并轨「标题序号」等新增校验要求。 **修改目的：** 统一词条文档类型命名为「术语词条」，按规范自定标准（CE-05/CW-02）整改链接与书名号，治理校验清单条目，实现资料规范与技能的自洽、可校验。 **修改内容：** 1. **词条文档类型统一更名**：文档类型由「算法词条/量化术语百科」统一为「术语词条」，模板与校验清单文件更名 term_glossary，docs-management 技能及各文档引用同步更新。 2. **规范自洽性整改**：按 CE-05 将文档类型表链接锚文本与正文标题引用改为中文正式标题并补链接（《公共校验清单》《流程指南模板》《术语词条模板》等），清理「排版规范」失效示例与失效引用，使规范符合自身定义。 3. **校验清单条目治理**：五类专属校验清单按严重级别（ERROR/WARN）重排并连续编号（TE/TW、PE/PW、QE/QW、LE/LW、GC），删除自相矛盾/失效条目（如流程示意节点数阈值矛盾），并轨主干「标题序号」条目（QW-07/LW-07）与模板章节编号标题。 ## 3. 功能验证 - [x] 资料规范自洽复核：全书名号、链接锚文本、失效引用、[OPTIONAL] 标记与 02-05 模板一致 - [x] 文件更名后链接复查：模板/校验清单互为引用、README 文档类型表、validation_rules、inventory 全部指向 01_term_glossary_* - [x] 校验清单编号连续性/交叉引用自检：全部编号有定义、引用可解析 - [x] 与主干冲突已解决并 rebase 至最新 master（并轨 MR !808 标题序号要求），PR 无冲突 ## 4. 自检 - [x] 是否未采集或打印敏感信息：是（纯文档） - [x] 是否已正确设置文件权限：是（纯文档） - [x] 典型安全编码问题：N/A - [x] UT 测试用例看护：N/A（文档 PR） - [x] 是否需要添加冒烟：否 See merge request: Ascend/msmodelslim!815 | 19 天前 | |
[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 | 11 天前 | |
[Doc] API 参考文档对齐当前 CLI：参数改用规范名并对齐配置文档与文档规范 #483 Co-authored-by: rookie_hongchuan<hongchuan6@h-partners.com> # message auto-generated for no-merge-commit merge: !860 merge docs/fix-api-reference into master [Doc] API 参考文档对齐当前 CLI：参数改用规范名并对齐配置文档与文档规范 #483 Created-by: rookie_hongchuan Commit-by: rookie_hongchuan Merged-by: ascend-robot Description: 关联 issue：#483 ## 1. 影响面评估 **接口变更（按需）：** 无 > 仅文档表述，不涉及代码接口。 **输出件变更（按需）：** 无 **非兼容变更（按需）：** 无 **SIG 评审结论（按需）：** 无 > 纯文档改动，无接口/安全/架构变更，无需 SIG 评审。 ## 2. 修改描述 **修改背景（可选）：** CLI 已把参数改用规范名（ --config_path→--config、 --tag→--tags、--pattern→--patterns、--topk→--top_k），但已合入的 API 参考 文档仍沿用旧名称，且部分配置文档/docstring 与文档规范（数字单位间距、术语、标题标号）未对齐。 **修改目的：** 让 API 参考与配置文档对齐当前 CLI 契约与文档规范，消除文档与实现漂移。 **修改内容：**（按「概念 - 变化」分条） - cli：quant/analyze/tune 命令行 API 文档改用规范名 --config/--tags/--patterns/--top_k， 补充 --device_id/--log_level/-v/-q，修正 --trust_remote_code 与设备语义 - config：api_reference/config/** 相关配置文档按文档规范统一描述与术语 - docs：docs_standards 的 01/03 checklist 与模板按标题标号与规范修订 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验 - [ ] 本地自验用例截图（文档改动，未涉及） **复现步骤（可选）：** N/A（纯文档改动） ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据：N/A（纯文档） - [x] 是否未采集或打印敏感信息 - [x] 是否已正确设置文件权限：N/A（纯文档） - [x] 是否充分考虑浮点运算溢出、除零等异常场景：N/A（纯文档） - [x] 是否已对正则表达式做 ReDos 检查：N/A（纯文档） **DT** - [x] 是否具备 UT 测试用例看护：N/A（纯文档改动，不涉及代码逻辑） - [x] 是否需要添加冒烟：否（文档改动） See merge request: Ascend/msmodelslim!860 | 6 天前 | |
[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 | 11 天前 |