| [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 | 1 天前 |
