已开启
[Doc]: API 参考文档参数与当前 CLI 不一致,需按规范名对齐 #483
rookie_hongchuan创建于 9 天前
9 天前 添加了label:document
anreywmh
9 天前 评论:
9 天前 评论:
👋 您好,欢迎向 MindStudio msModelSlim 提交 Issue!
我们已收到您的反馈,感谢你对开源社区的支持。🎉
📅处理时效: 维护团队将在24小时内 查看并回复您的问题(工作日)。
🔍自助查询: 在等待期间,建议您先查阅以下资料,可能已有解决方案:
📖 MindStudio msModelSlim 官方文档
📝 贡献者指南
请确保 Issue 描述清晰,包含复现步骤和日志,这将帮助我们更快定位问题。谢谢!


9 天前 关联了pull request:[Doc] API 参考文档对齐当前 CLI:参数改用规范名并对齐配置文档与文档规范 #483
rookie_hongchuan
5 天前 评论:
5 天前 评论:
/label add resolved


5 天前 添加了label:resolved
Documentation Location | 文档位置(可指定多个文档链接)
https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/api_reference/cli/msmodelslim_quant.md
https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/api_reference/cli/msmodelslim_analyze.md
https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/api_reference/cli/msmodelslim_tune.md
以及以下文档规范文件:
https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/development_guide/docs_standards/01_term_glossary_checklist.md
https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/development_guide/docs_standards/03_general_case_checklist.md
及对应 template 文件、docs/zh/api_reference/config/** 配置文档
Current Content Description | 文档问题描述
1、CLI 已把参数改用规范名:
--config_path→--config、--tag→--tags、--pattern→--patterns、--topk→--top_k,并新增--device_id、--log_level、-v、-q;但已合入 master 的 API 参考文档(cli/quant/analyze/tune)以及部分正文描述仍沿用旧参数名(
--config_path、--tag、--topk),与当前 CLI 契约不一致。2、docs_standards 的 checklist/模板及部分配置文档与最新文档规范(数字与单位间距、
术语统一、标题标号)未完全对齐。
Modification Suggestion | 修改建议
1、API 参考 CLI 文档按当前 CLI 契约对齐规范名,并补充
--device_id/--log_level/-v/-q;2、docs_standards checklist/模板及配置文档按文档规范统一数字单位间距、术语与标题标号。