| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
[Doc] 修复 issue 528 part.1（cli 和 config 文档问题及相关引用更新） Co-authored-by: jiamingxuaa<xujiaming19@h-partners.com> # message auto-generated for no-merge-commit merge: !1021 merge master into master [Doc] 修复 issue 528 part.1（cli 和 config 文档问题及相关引用更新） Created-by: jiamingxuaa Commit-by: jiamingxuaa 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 等请在此项补充说明。 **输出件变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及导出格式、产物路径等请在此项补充说明。 **非兼容变更（按需）：** 文档路径调整（书签/外链需迁移） - docs/zh/api_reference/config/task/ → docs/zh/api_reference/config/quant/ - 删除手写页 docs/zh/api_reference/config/auto_precision_tuning.md，改由 config/tuning/README.md + 既有 tuning/* 字段页承接 - docs/zh/api_reference/config/processor_group.md → docs/zh/user_guide/usage_processor_group.md 迁移：将旧链接中的 config/task/ 改为 config/quant/；自动调优协议说明改链至 config/tuning/README.md；组合处理器用法改链至 user_guide/usage_processor_group.md。仓库内交叉引用已同步更新。 **SIG 评审结论（按需）：** 无 > 提醒：非兼容、安全风险等高危 PR 须经 SIG 评审后合入；无则保留「无」。 ## 2. 修改描述 **修改背景（可选）：** API Reference 中配置文档按类型组织，缺少统一的“先选协议 / 再按 type 查处理器”导航；CLI 与配置字段说明、示例标签等与现状不完全一致；自动调优手写长文与 tuning/ 生成页并存，入口分散；以及[测试提出的各种修改建议](https://gitcode.com/Ascend/msmodelslim/issues/528)。 **修改目的：** 理顺cli / config 文档层级与导航，校准命令行与配置字段说明，并同步全库交叉链接与文档生成约定，降低查阅与后续维护成本。 **修改内容：** - cli：新增 api_reference/cli/README.md（全局/公共参数、子命令总览）；校准 quant / analyze / eval / tune 参数表、互斥关系、权重转换省略 --model_type、--save_path 公共化、tags 示例等表述 - docs/api_reference/config：新增手写导航 config/README.md、config/quant/README.md、config/tuning/README.md；任务配置目录 task/ 重命名为 quant/；删除 auto_precision_tuning.md；组合处理器说明迁至 user_guide/usage_processor_group.md - docs/api_reference/config（生成页）：更新 processor/*、format/*、tuning/* 及 quant/* 字段说明/结构（如 modelslim_convert、evaluation_service_oriented、group、trainable_linear_quant 等） - docs/knowledge_base & user_guide & skills：批量将 config/task/ 链接改为 config/quant/，并同步自动调优/组合处理器相关入口 - docs/contributing & skills/docs-management：更新 api_reference_docgen.md 与脚本 README，明确 quant/ 产出目录、手写 README.md 受 MANUAL_KEEP 保护、配置块编号最多 3 段等约定 **概念域参考（填写提示）：** 说明：本 PR 为文档与导航重构，未改动 app / core / infra / utils 运行时代码；修改内容主要落在 cli（文档） 与文档体系本身。 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [ ] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） **复现步骤（可选）：** bash # 在此粘贴可复现命令 ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [ ] 是否已校验外部数据 - [x] 是否未采集或打印敏感信息 - [ ] 是否已正确设置文件权限 - [ ] 是否充分考虑浮点运算溢出、除零等异常场景 - [ ] 是否已对正则表达式做 ReDos 检查 **DT** - [ ] 是否具备 UT 测试用例看护（路径：用例路径；未添加请说明原因） - [x] 是否需要添加冒烟：否（若「是」请说明冒烟场景及对应用途） See merge request: Ascend/msmodelslim!1021 | 1 个月前 | |
【docs】：Atals 800I A2/3产品名称描述统一 Co-authored-by: zzm30<zhengzhimin1@h-partners.com> # message auto-generated for no-merge-commit merge: !941 merge master into master 【docs】：Atals 800I A2/3产品名称描述统一 Created-by: zzm30 Commit-by: zzm30 Merged-by: ascend-robot Description: # PR 提交说明 提交前请阅读 [CONTRIBUTING.md](https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/contributing_guide.md)，开发者文档：[模型接入指南](../docs/zh/development_guide/integrating_models.md) PR 标题前缀：[Feature]、[Bugfix]、[Doc]、[Test]（与 CONTRIBUTING 一致） ## 1. 影响面评估 **接口变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及 CLI、API、YAML 等请在此项补充说明。 **输出件变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及导出格式、产物路径等请在此项补充说明。 **非兼容变更（按需）：** 无 > 备注：若无变更请保留「无」；若有非兼容变更请说明迁移方式。 **SIG 评审结论（按需）：** 无 > 提醒：非兼容、安全风险等高危 PR 须经 SIG 评审后合入；无则保留「无」。 ## 2. 修改描述 **修改背景（可选）：** 文档中同一款产品存在多种描述说法； **修改目的：** Atlas 800I A2/A3的说法统一； **修改内容：** 1. Atals 800I A2/3产品名称描述统一 **概念域参考（填写提示）：** - cli：命令行 quant / analyze / tune - app：最佳实践量化、量化分析、精度反馈自动调优等 - core：算法、量化服务、调度、张量量化、调优策略、最佳实践、上下文等 - infra：模型适配、调优计划/历史/缓存、测评服务等 - utils：日志、错误处理、插件等 ## 3. 功能验证 - [x] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据 - [x] 是否未采集或打印敏感信息 - [x] 是否已正确设置文件权限 - [x] 是否充分考虑浮点运算溢出、除零等异常场景 - [x] 是否已对正则表达式做 ReDos 检查 **DT** - [x] 是否具备 UT 测试用例看护 资料修改 - [ ] 是否需要添加冒烟：否 See merge request: Ascend/msmodelslim!941 | 1 个月前 | |
[Doc] 重组中文资料目录并同步导航与链接 Co-authored-by: joejoezhou<zhourongchen1@huawei.com> # message auto-generated for no-merge-commit merge: !761 merge feature/docs-dirs into master [Doc] 重组中文资料目录并同步导航与链接 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. 修改描述 **修改背景（可选）：** 中文资料目录层级混乱，流程与概念混杂，导航与相对链接随历史迁移积累了失效路径。 **修改目的：** 重组 docs/zh 目录结构，统一以流程指南/知识库/案例参考三类文档分层，并同步导航、索引与全库相关链接。 **修改内容：** - docs：新增推理加速知识库 knowledge_base，按 knowledge_base / user_guide / contributing / api_reference / best_practices / legal 重组中文资料 - docs：每个算法单独子目录、每个调优策略单独子目录、每个量化格式单独子目录 - docs：更新流程指南，区分业务流程和工具使用流程；算法总览补齐子算法 - docs：修复迁移后失效/过时链接，同步 mkdocs 导航（仅改路径，顶层序号与 master 一致） - docs：按评审意见修正相对路径、书名号外层、文档链接书名号与完整句句号 - docs：PR 模板中模型接入路径对齐新目录；清除 V0 案例残留 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据（N/A） - [x] 是否未采集或打印敏感信息（N/A） - [x] 是否已正确设置文件权限（N/A） - [x] 是否充分考虑浮点运算溢出、除零等异常场景（N/A） - [x] 是否已对正则表达式做 ReDos 检查（N/A） **DT** - [x] 是否具备 UT 测试用例看护（路径：用例路径；未添加请说明原因）：文档重组，无代码逻辑变更，不新增 UT - [x] 是否需要添加冒烟：否 See merge request: Ascend/msmodelslim!761 | 3 个月前 | |
【master】【docs】：托管文档残留格式删除；AIDD低错修改；文档编码格式修改 Co-authored-by: zzm30<zhengzhimin1@h-partners.com> # message auto-generated for no-merge-commit merge: !1051 merge master into master 【master】【docs】：托管文档残留格式删除；AIDD低错修改；文档编码格式修改 Created-by: zzm30 Commit-by: zzm30 Merged-by: ascend-robot Description: # PR 提交说明 提交前请阅读 [CONTRIBUTING.md](https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/contributing_guide.md)，开发者文档：[模型接入指南](../docs/zh/development_guide/integrating_models.md) PR 标题前缀：[Feature]、[Bugfix]、[Doc]、[Test]（与 CONTRIBUTING 一致） ## 1. 影响面评估 **接口变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及 CLI、API、YAML 等请在此项补充说明。 **输出件变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及导出格式、产物路径等请在此项补充说明。 **非兼容变更（按需）：** 无 > 备注：若无变更请保留「无」；若有非兼容变更请说明迁移方式。 **SIG 评审结论（按需）：** 无 > 提醒：非兼容、安全风险等高危 PR 须经 SIG 评审后合入；无则保留「无」。 ## 2. 修改描述 **修改背景（可选）：** 版本发布前低错问题清零；链接需要与版本对应； **修改目的：** aidd新增低错问题修改；链接版本对应; **修改内容：** 1. 托管文档残留格式删除； 2. aidd新增低错问题修改； 3. 因vscode编辑器编码格式，导致昇腾社区显示异常，文档编码格式修改：“UTF-8 with BOM”修改为“UTF-8”。 **概念域参考（填写提示）：** - cli：命令行 quant / analyze / tune - app：最佳实践量化、量化分析、精度反馈自动调优等 - core：算法、量化服务、调度、张量量化、调优策略、最佳实践、上下文等 - infra：模型适配、调优计划/历史/缓存、测评服务等 - utils：日志、错误处理、插件等 ## 3. 功能验证 - [x] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据 - [x] 是否未采集或打印敏感信息 - [x] 是否已正确设置文件权限 - [x] 是否充分考虑浮点运算溢出、除零等异常场景 - [x] 是否已对正则表达式做 ReDos 检查 **DT** - [x] 是否具备 UT 测试用例看护 资料修改 - [ ] 是否需要添加冒烟：否 See merge request: Ascend/msmodelslim!1051 | 20 天前 | |
[Doc] 重组中文资料目录并同步导航与链接 Co-authored-by: joejoezhou<zhourongchen1@huawei.com> # message auto-generated for no-merge-commit merge: !761 merge feature/docs-dirs into master [Doc] 重组中文资料目录并同步导航与链接 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. 修改描述 **修改背景（可选）：** 中文资料目录层级混乱，流程与概念混杂，导航与相对链接随历史迁移积累了失效路径。 **修改目的：** 重组 docs/zh 目录结构，统一以流程指南/知识库/案例参考三类文档分层，并同步导航、索引与全库相关链接。 **修改内容：** - docs：新增推理加速知识库 knowledge_base，按 knowledge_base / user_guide / contributing / api_reference / best_practices / legal 重组中文资料 - docs：每个算法单独子目录、每个调优策略单独子目录、每个量化格式单独子目录 - docs：更新流程指南，区分业务流程和工具使用流程；算法总览补齐子算法 - docs：修复迁移后失效/过时链接，同步 mkdocs 导航（仅改路径，顶层序号与 master 一致） - docs：按评审意见修正相对路径、书名号外层、文档链接书名号与完整句句号 - docs：PR 模板中模型接入路径对齐新目录；清除 V0 案例残留 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据（N/A） - [x] 是否未采集或打印敏感信息（N/A） - [x] 是否已正确设置文件权限（N/A） - [x] 是否充分考虑浮点运算溢出、除零等异常场景（N/A） - [x] 是否已对正则表达式做 ReDos 检查（N/A） **DT** - [x] 是否具备 UT 测试用例看护（路径：用例路径；未添加请说明原因）：文档重组，无代码逻辑变更，不新增 UT - [x] 是否需要添加冒烟：否 See merge request: Ascend/msmodelslim!761 | 3 个月前 |
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 1 个月前 | ||
| 1 个月前 | ||
| 3 个月前 | ||
| 20 天前 | ||
| 3 个月前 |