ascend-robot[Feature] msAgent Skills迁移msModelSlim仓

文件	最后提交记录	最后更新时间
README.md	[Feature] msAgent Skills迁移msModelSlim仓 Co-authored-by: joejoezhou<zhourongchen1@huawei.com> # message auto-generated for no-merge-commit merge: !907 merge feature/agent-skills into master [Feature] msAgent Skills迁移msModelSlim仓 Created-by: joejoezhou Commit-by: joejoezhou 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. 影响面评估接口变更（按需）：无输出件变更（按需）：无非兼容变更（按需）：无 SIG 评审结论（按需）：无 ## 2. 修改描述修改背景（可选）： msAgent skills迁移到msModelSlim，便于用户下载msModelSlim即可快速量化调优修改目的： msAgent skills迁移到msModelSlim 修改内容： - skills：新增安装、适配、敏感层分析、调优策略、量化、评测、调优编排skills ## 3. 功能验证冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） ## 4. 自检（请逐项确认，不适用标 N/A）典型安全编码问题 - [x] 是否已校验外部数据 - [x] 是否未采集或打印敏感信息 - [x] 是否已正确设置文件权限 - [x] 是否充分考虑浮点运算溢出、除零等异常场景 - [x] 是否已对正则表达式做 ReDos 检查 DT - [x] 是否具备 UT 测试用例看护（路径：用例路径；未添加请说明原因）：N/A（本 PR 主要为 skills 文档与验证脚本） - [x] 是否需要添加冒烟：否（若「是」请说明冒烟场景及对应用途） See merge request: Ascend/msmodelslim!907	13 天前
gen_config_api_docs.py	[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	27 天前
gen_quant_config_docs.py	[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	27 天前
quant_config_docgen.py	[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	22 天前

接口文档生成器

从源码注解生成 docs/zh/api_reference/config/ 下的量化配置文档（模板 04）。请改源码注解后重新生成，不要手工改带 generated-by 标记的配置文档。

命令行 API 文档（模板 05）不自动抽取：对照 msmodelslim.cli 实现与 --help，按《命令行 API 文档模板》撰写，提交前按《命令行 API 文档校验清单》检查。现稿在 docs/zh/api_reference/cli/。

配置生成器的设计说明见《接口文档自动生成设计》。内部类以 YAML type 的 _ 前缀判定；配置「含义」只来自 Field(description=)，跨字段约束只来自 validator docstring。

量化配置（模板 04）

从 Pydantic model_json_schema() 生成 docs/zh/api_reference/config/，并按类型放入 task/、processor/、format/、tuning/ 等子目录。服务规格（spec）不再单独成页，而是随对应 task 页展开。字段类型、枚举、边界以 JSON Schema 为准。

日常重新生成使用驱动脚本（默认目标 + 展开嵌套 + 清理过期文档）：

python3 skills/docs-management/scripts/gen_config_api_docs.py
python3 skills/docs-management/scripts/gen_config_api_docs.py --dry-run
python3 skills/docs-management/scripts/gen_config_api_docs.py --check

基础脚本 gen_quant_config_docs.py 提供目标 / 展开 / 清理等基础能力，供需要精确控制时使用：

python3 skills/docs-management/scripts/gen_quant_config_docs.py --targets processor --dry-run
python3 skills/docs-management/scripts/gen_quant_config_docs.py --check

参数	含义
`--output`	输出目录，默认 `docs/zh/api_reference/config`
`--dry-run`	只打印将写入的路径
`--check`	对比已生成文档与当前注解，不一致时退出码为 1
`--update-mkdocs`	写入 `mkdocs.yml` 导航；默认不改该文件

取值范围只收录 JSON Schema 里的 enum / const / minimum / maxLength 等。写在 AfterValidator 闭包里的长度或区间不会进入文档，应改成 Field(max_length=) / ge / le。

生成规则：

每个对外 Pydantic 配置类生成一份 Markdown；type 以 _ 开头的内部配置不生成。
文档按类型子目录组织：任务配置 task/、处理器 processor/、保存格式 format/、自动调优 tuning/；服务规格随 task 页展开，不单独生成 spec/ 页面。
参数表「字段路径」为相对当前配置的字段名；子标题不显示 YAML 路径后缀。
参数列表按配置类名分块组织，块标题带可见编号（如 <h3 id="2-1-...">2.1类名</h3>、<h4 id="...">2.x 派生类名</h4>）；每个块含自身参数表与「配置约束」子项；嵌套配置（含 task 的 spec）展开进对应子块；嵌套块若类 docstring 首段非空，标题后先输出该句类概述。
PracticeConfig（BaseQuantConfig 子类，含 metadata → Metadata）作为任务基类配置独立成 task/practice_config.md 页，被调优策略引用时链接到该页。
type/mode 分派字段（process、save、strategy、evaluation、select_best、operations、preprocess 等）渲染为基础类块（<h3 id="…">基础类名（按 type 分派）</h3>，含基础类参数表与「派生类」列表）+ 各派生类 <h4 id="…"> 子块；同一页面同一基础类只渲染一次，分派字段的「引用配置」列统一指向基础类块锚点。
配置块标题与页内跳转统一用 HTML 标签（<h3 id> / <h4 id> / <a href="#…">），不使用 Markdown 的 {#anchor} 属性语法。
不再生成 config/README.md 索引页。
文件名优先使用公开 type（如 linear_quant.md），否则使用类名的 snake_case。
顶层任务配置保留稳定文件名：modelslim_v1.md、multimodal_vlm_modelslim_v1.md、multimodal_sd_modelslim_v1.md、modelslim_convert.md、practice_config.md。
手写文档 processor_group.md、auto_precision_tuning.md 不会被覆盖。
「完整配置参考」仅当能抽出可加载的完整 YAML（真实字段路径 + 根配置校验通过、apiversion 不为 Unknown）时生成；自动调优配置无 apiversion 根，改用类内 json_schema_extra.examples 声明的子树示例组装成完整的 strategy + evaluation 形态。
生成文件带 HTML 注释标记 generated-by: skills/docs-management/scripts/gen_quant_config_docs.py。