| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
[Doc] 整改知识库 quantization_algorithms 量化算法文档 Co-authored-by: qq_46439621<wanlongze1@huawei.com> # message auto-generated for no-merge-commit merge: !876 merge algo_fix_0825 into master [Doc] 整改知识库 quantization_algorithms 量化算法文档 Created-by: qq_46439621 Commit-by: qq_46439621 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 等请在此项补充说明。 **输出件变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及导出格式、产物路径等请在此项补充说明。 **非兼容变更（按需）：** 无 > 备注：若无变更请保留「无」；若有非兼容变更请说明迁移方式。 **SIG 评审结论（按需）：** 无 > 提醒：非兼容、安全风险等高危 PR 须经 SIG 评审后合入；无则保留「无」。 ## 2. 修改描述 **修改背景（可选）：** 量化算法知识库文档结构不一致，词条（term）与使用指南（usage）的格式模板不统一，导致用户查阅时理解成本高；部分文档缺失阅读指引和关联知识链接，不利于从算法总览到具体配置的渐进式阅读。 **修改目的：** 统一文档模板，完善阅读指引和关联跳转，降低用户理解门槛。 **修改内容：** - docs/知识库：重构量化算法知识库文档模板，统一词条（term）与使用指南（usage）的文档结构；词条统一采用「概述 → 原理 → 性质 → 适用场景 → 关联知识」结构，使用指南统一采用「功能定义 → 配置参数 → 何时调整 → 使用示例」结构 - docs/知识库：新增 ra_compress 算法词条与使用指南，覆盖低秩注意力压缩量化方案 - docs/知识库：README 总览页补充阅读建议，引导用户先读词条再读使用指南，并指向 modelslim_v1 配置说明文档 - docs/知识库：各算法文档外链从相对路径改为 README 锚点跳转，支持跨文档快速导航 **概念域参考（填写提示）：** - cli：命令行 quant / analyze / tune - app：最佳实践量化、量化分析、精度反馈自动调优等 - core：算法、量化服务、调度、张量量化、调优策略、最佳实践、上下文等 - infra：模型适配、调优计划/历史/缓存、测评服务等 - utils：日志、错误处理、插件等 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） **复现步骤（可选）：** bash # 文档变更，无运行验证步骤 ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] N/A — 是否已校验外部数据（文档变更，不涉及数据输入） - [x] N/A — 是否未采集或打印敏感信息（文档变更，不涉及敏感信息） - [x] N/A — 是否已正确设置文件权限（文档变更，不涉及文件权限） - [x] N/A — 是否充分考虑浮点运算溢出、除零等异常场景（文档变更，不涉及浮点运算） - [x] N/A — 是否已对正则表达式做 ReDos 检查（未使用正则表达式） **DT** - [x] N/A — 是否具备 UT 测试用例看护（文档变更，无 UT 用例） - [x] 是否需要添加冒烟：否（若「是」请说明冒烟场景及对应用途） See merge request: Ascend/msmodelslim!876 | 9 天前 | |
[Doc] 整改知识库 quantization_algorithms 量化算法文档 Co-authored-by: qq_46439621<wanlongze1@huawei.com> # message auto-generated for no-merge-commit merge: !876 merge algo_fix_0825 into master [Doc] 整改知识库 quantization_algorithms 量化算法文档 Created-by: qq_46439621 Commit-by: qq_46439621 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 等请在此项补充说明。 **输出件变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及导出格式、产物路径等请在此项补充说明。 **非兼容变更（按需）：** 无 > 备注：若无变更请保留「无」；若有非兼容变更请说明迁移方式。 **SIG 评审结论（按需）：** 无 > 提醒：非兼容、安全风险等高危 PR 须经 SIG 评审后合入；无则保留「无」。 ## 2. 修改描述 **修改背景（可选）：** 量化算法知识库文档结构不一致，词条（term）与使用指南（usage）的格式模板不统一，导致用户查阅时理解成本高；部分文档缺失阅读指引和关联知识链接，不利于从算法总览到具体配置的渐进式阅读。 **修改目的：** 统一文档模板，完善阅读指引和关联跳转，降低用户理解门槛。 **修改内容：** - docs/知识库：重构量化算法知识库文档模板，统一词条（term）与使用指南（usage）的文档结构；词条统一采用「概述 → 原理 → 性质 → 适用场景 → 关联知识」结构，使用指南统一采用「功能定义 → 配置参数 → 何时调整 → 使用示例」结构 - docs/知识库：新增 ra_compress 算法词条与使用指南，覆盖低秩注意力压缩量化方案 - docs/知识库：README 总览页补充阅读建议，引导用户先读词条再读使用指南，并指向 modelslim_v1 配置说明文档 - docs/知识库：各算法文档外链从相对路径改为 README 锚点跳转，支持跨文档快速导航 **概念域参考（填写提示）：** - cli：命令行 quant / analyze / tune - app：最佳实践量化、量化分析、精度反馈自动调优等 - core：算法、量化服务、调度、张量量化、调优策略、最佳实践、上下文等 - infra：模型适配、调优计划/历史/缓存、测评服务等 - utils：日志、错误处理、插件等 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） **复现步骤（可选）：** bash # 文档变更，无运行验证步骤 ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] N/A — 是否已校验外部数据（文档变更，不涉及数据输入） - [x] N/A — 是否未采集或打印敏感信息（文档变更，不涉及敏感信息） - [x] N/A — 是否已正确设置文件权限（文档变更，不涉及文件权限） - [x] N/A — 是否充分考虑浮点运算溢出、除零等异常场景（文档变更，不涉及浮点运算） - [x] N/A — 是否已对正则表达式做 ReDos 检查（未使用正则表达式） **DT** - [x] N/A — 是否具备 UT 测试用例看护（文档变更，无 UT 用例） - [x] 是否需要添加冒烟：否（若「是」请说明冒烟场景及对应用途） See merge request: Ascend/msmodelslim!876 | 9 天前 |
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 9 天前 | ||
| 9 天前 |