已合并
[Doc] API 参考文档对齐当前 CLI：参数改用规范名并对齐配置文档与文档规范 #483 #860
rookie_hongchuan创建于 6 天前
[Doc] API 参考文档对齐当前 CLI：参数改用规范名并对齐配置文档与文档规范 #483 #860
已合并
Pull Request已成功合入, 合并人@ascend-robot
（感谢 rookie_hongchuan 的贡献）6 天前 关联了issue：[Doc]: API 参考文档参数与当前 CLI 不一致，需按规范名对齐
atomgit-bot
6 天前 评论：
6 天前 评论：
变更摘要
本 PR 为纯文档改动，目标是让 API 参考文档与配置文档对齐当前 CLI 契约及文档规范，消除文档与实现之间的漂移。由于 CLI 已把参数改用规范名（--config_path→--config、--tag→--tags、--pattern→--patterns、--topk→--top_k），而已合入的 API 参考文档仍沿用旧名称，本 PR 对 quant/analyze/tune 命令行 API 文档、api_reference/config/** 配置文档及 docs_standards 规范模板进行同步修订，不涉及任何代码接口、安全或架构变更。
主要改动
- CLI 参数名对齐规范名：
quant/analyze/tune命令行 API 参考文档将旧参数--config_path/--tag/--pattern/--topk改用规范名--config/--tags/--patterns/--top_k，使文档与当前 CLI 契约一致。 - 补充缺失参数并修正语义：补充
--device_id/--log_level/-v/-q等参数说明，并修正--trust_remote_code与设备相关的语义描述。 - 配置文档统一描述与术语：
api_reference/config/**相关配置文档按文档规范统一描述与术语，与配置文档及 docstring 保持对齐。 - 文档规范模板修订：
docs_standards的 01/03 checklist 与模板按标题标号与文档规范要求进行修订。
AtlasAccount
6 天前 评论：
6 天前 评论：
atomgit-bot
6 天前 评论：
6 天前 评论：
🤖 本次改动均为数据 / 生成 / 二进制文件（如测试用例、锁文件、媒体资源），没有可审查的代码逻辑，已跳过 AI 代码审查。
6 天前 添加了label：ascend-cla/yes
此处折叠了68条消息 查看更多
libowen
2 天前 评论：
2 天前 评论：
/lgtm
2 天前 添加了label：lgtm
2 天前 添加了label：approved
2 天前 合入了pull request
关联 issue：#483
1. 影响面评估
接口变更（按需）： 无
输出件变更（按需）： 无
非兼容变更（按需）： 无
SIG 评审结论（按需）： 无
2. 修改描述
修改背景（可选）： CLI 已把参数改用规范名（
--config_path→--config、--tag→--tags、--pattern→--patterns、--topk→--top_k），但已合入的 API 参考文档仍沿用旧名称，且部分配置文档/docstring 与文档规范（数字单位间距、术语、标题标号）未对齐。
修改目的： 让 API 参考与配置文档对齐当前 CLI 契约与文档规范，消除文档与实现漂移。
修改内容：（按「概念 - 变化」分条）
--config/--tags/--patterns/--top_k，补充
--device_id/--log_level/-v/-q，修正--trust_remote_code与设备语义3. 功能验证
冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。
复现步骤（可选）： N/A（纯文档改动）
4. 自检（请逐项确认，不适用标 N/A）
典型安全编码问题
DT