| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
[Doc] 新增 msModelSlim 架构说明文档 Co-authored-by: joejoezhou<zhourongchen1@huawei.com> # message auto-generated for no-merge-commit merge: !452 merge docs/architecture into master [Doc] 新增 msModelSlim 架构说明文档 Created-by: joejoezhou Commit-by: joejoezhou Merged-by: ascend-robot Description: # 提交前请阅读 [CONTRIBUTING.md](https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/appendix/CONTRIBUTING.md)，开发者文档：[模型接入指南](https://msmodelslim.readthedocs.io/zh-cn/latest/zh/developer_guide/integrating_models/) **PR 标题前缀：** [Doc] --- ## 1. 影响面评估 - **接口变更（按需）：** 无 - **输出件变更（按需）：** 无 - **非兼容变更（按需）：** 无 - **SIG 评审结论（按需）：** N/A（纯文档变更，无安全风险） --- ## 2. 修改描述 - **修改背景（可选）：** msModelSlim 已有功能指南、算法说明、模型接入等文档，但缺少一份面向开发者的**整体架构说明**。新同学需要自行拼凑各章节才能理解工具的分层设计、核心概念与代码目录的对应关系，上手成本较高。 - **修改目的：** 在开发者指南中新增架构说明，作为阅读其他文档和接入模型前的**总览入口**，帮助开发者建立对 msModelSlim 设计理念与模块划分的统一认知。 - **修改内容：** 本 PR 交付一套完整的架构文档及配套入口，具体包括： - docs/开发者指南：新增 docs/zh/developer_guide/architecture.md，系统介绍设计理念、四层架构（接口层 / 应用层 / 领域层 / 基础设施层），以及量化模式、量化算法、模型适配、量化格式等核心概念 - docs/配图：新增 docs/assets/architecture.png，提供整体架构示意图 - docs/站点导航：在 mkdocs.yml「五、开发者指南」首位挂载「架构说明」，Read the Docs 侧栏可直接访问 - docs/仓库入口：在 README.md「自主量化」小节增加架构说明链接，引导开发者先了解整体设计再阅读接入指南 - [ ] **涉及代码双合**（关联 PR 链接）：无 --- ## 3. 功能验证 > 冒烟由 CI 门禁检查，无需在此填写「冒烟是否通过」。 - [x] **功能自验**（文档内容、相对路径、mkdocs 导航、README 链接均已核对） - [ ] **本地自验用例截图**（纯文档 PR，无需截图） **CI：** docs-ci 已通过。 --- ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] **是否已校验外部数据** — N/A（无代码逻辑） - [x] **是否未采集或打印敏感信息** — N/A - [x] **是否已正确设置文件权限** — N/A - [x] **是否充分考虑浮点运算溢出、除零等异常场景** — N/A - [x] **是否已对正则表达式做 ReDos 检查** — N/A **DT** - [x] **是否具备 UT 测试用例看护** — 未添加；纯文档变更，不涉及代码行为，无需 UT - [x] **是否需要添加冒烟：** 否；由 docs-ci 门禁覆盖 See merge request: Ascend/msmodelslim!452 | 4 个月前 | |
根据《MindStudio 统一命令行方案》对各类参数进行统一规范化，同时考虑msmodelslim本身需求，保留了下划线形式。增加了版本参数命令和完善了help命令 Co-authored-by: Rigel_Chen<chenruijie9@huawei.com> # message auto-generated for no-merge-commit merge: !805 merge cli-standardization into master [Bugfix]命令行参数优化与help提示优化 Created-by: Rigel_Chen Commit-by: Rigel_Chen 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 命令行参数接口发生变更： --topk → --top_k、--calib_dataset → --calibration_dataset、--pattern → --patterns、--tag → --tags 旧 snake_case 写法保留为隐藏兼容别名，仍可解析但触发弃用告警；不在 --help 中展示 新增顶层 --version / -V 参数 新增统一日志开关 --log_level、-v/--verbose、-q/--quiet 布尔参数 --trust_remote_code 改为 flag 用法（兼容旧 True/False 值写法） **输出件变更（按需）：** 无 > 备注：若无变更请保留「无」；涉及导出格式、产物路径等请在此项补充说明。 **非兼容变更（按需）：** 无 > 备注：若无变更请保留「无」；若有非兼容变更请说明迁移方式。 **SIG 评审结论（按需）：** 无 > 提醒：非兼容、安全风险等高危 PR 须经 SIG 评审后合入；无则保留「无」。 ## 2. 修改描述 **修改背景（可选）：** 当前 msmodelslim CLI 参数命名与 MindStudio 工具链其他工具不一致（snake_case、缺少 --version、帮助信息不完整），导致用户跨工具学习成本高、AI Agent 难以自动化调用 **修改目的：** 依据《MindStudio 工具链命令行统一规范化设计方案》，将 msmodelslim 的 CLI 参数体系收敛到统一规范（kebab-case 长选项、--version、统一日志开关、统一帮助信息），同时通过隐藏兼容别名保证存量脚本零中断。 **修改内容：** cli：长选项统一为 kebab-case，旧 snake_case 降级为隐藏兼容别名并触发一次性弃用告警 cli：新增顶层 --version / -V 版本查询参数（含 MindStudio Logo、Git commit hash、Copyright、License） cli：新增统一日志开关 --log-level {debug,info,warning,error}、-v/--verbose、-q/--quiet，并按冲突裁决规则生效 cli：布尔参数 --trust-remote-code 改为 flag 用法（兼容旧 True/False 值写法） cli：带值参数补齐语义化取值占位符（metavar） cli：帮助信息补全，含用途、必填参数清单、示例、默认值标注 cli：优化帮助 formatter，--help 仅展示规范名、隐藏旧别名 （在此填写） **概念域参考（填写提示）：** - cli：命令行 quant / analyze / tune - app：最佳实践量化、量化分析、精度反馈自动调优等 - core：算法、量化服务、调度、张量量化、调优策略、最佳实践、上下文等 - infra：模型适配、调优计划/历史/缓存、测评服务等 - utils：日志、错误处理、插件等 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验 - [ ] 本地自验用例截图（请勿包含个人信息；可附复现命令） **复现步骤（可选）：** bash msmodelslim --version msmodelslim --help msmodelslim quant --help msmodelslim analyze linear --help msmodelslim tune --help # 旧别名弃用告警验证 msmodelslim quant --model_path ./dummy --save_path ./dummy-out --model_type Qwen2.5-7B-Instruct --help ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据 - [x] 是否未采集或打印敏感信息 - [x] 是否已正确设置文件权限 → N/A（纯 CLI 解析逻辑，无文件权限变更） - [x] 是否充分考虑浮点运算溢出、除零等异常场景 → N/A（不涉及浮点运算） - [x] 是否已对正则表达式做 ReDos 检查 → N/A（未新增正则表达式） **DT** - [x] 是否具备 UT 测试用例看护（路径：用例路径；未添加请说明原因） - [ ] 是否需要添加冒烟：否（若「是」请说明冒烟场景及对应用途） See merge request: Ascend/msmodelslim!805 | 1 个月前 | |
【docs】资料架构重构，并将资料托管至readthedocs。 Co-authored-by: keith_wa<keith_wwa@163.com> # message auto-generated for no-merge-commit merge: !109 merge pr_docs_re_copy into master 【docs】资料架构重构，并将资料托管至readthedocs。 Created-by: keith_wa Commit-by: keith_wa Merged-by: ascend-robot Description: 1. 动机 (Motivation) 内容上： 优化导航结构：原目录结构逻辑不清晰、目录层级深且链接复杂。 提升阅读体验：原 traditional_quantization_v0 目录下存在 20+ 个零散文档，内容分布碎片化，用户难以快速建立完整的技术全景认知。 消除内容冗余：多个文档之间存在重复的依赖说明、操作流程及参数介绍，增加了维护成本及版本不一致的风险。 呈现上： 提供专业资料托管：原docs/目录结构不清晰、目录名/文档名不直观（英文），跳转繁琐且无搜索功能。 2. 修改点 (Changes) 2.1 重新梳理目录结构  2.2. 文档整合与重构 V0及传统量化核心文档合并：将 20 多个零散文档按功能维度深度整合为 10篇核心指南： # V0框架文档导航（已停止演进） 本目录文档按模型类型与任务场景重排，便于按需求快速定位。 ## 一、传统模型量化与校准 - [传统模型量化与校准](traditional_model_quantization_and_calibration.md) - 包含 PyTorch/ONNX/MindSpore 训练后量化与 QAT。 ## 二、大模型量化与压缩 - [大模型量化与校准](foundation_model_quantization_and_calibration.md) - 包含低显存量化、混合校准数据集、FA3 量化。 - [压缩与结构优化（大模型为主）](foundation_model_compression.md) - 包含稀疏量化与权重压缩、长序列压缩、权重压缩流程、低秩分解。 ## 三、训练加速与模型改造 - [训练加速与模型改造](pruning_and_distillation.md) - 包含重要性剪枝、Transformer 剪枝、Sparse tool、模型蒸馏。 - [稀疏加速训练](sparse_acceleration_training.md) - 包含宽度扩增与深度扩增模型的稀疏训练加速流程。 ## 四、工具与生态适配 - [辅助工具与专项指导](compression_utils.md) - 包含量化权重格式说明与 MindSpeed 适配器。 - [伪量化精度测试工具](fake_quantization_accuracy_testing_tool.md) - 包含 Precision Tool 使用方式与测试流程。 - [多模态生成模型推理优化](inference_optimization_for_multimodal_generative_model.md) - 包含 DiT 缓存优化与自适应采样优化流程。 - [常见代码示例](quantization_and_sparse_quantization_scenario_import_code_examples.md) - 包含常见量化/稀疏量化场景导入代码样例。 2.3 配置readthedocs文档托管： https://modelslim.readthedocs.io/zh-cn/latest/ 2.4 配置deepwiki： https://deepwiki.com/Keithwwa/ModelSlim 3. 验证： 3.1. gimini代码检视： https://github.com/Keithwwa/ModelSlim/pull/1 See merge request: Ascend/msmodelslim!109 | 7 个月前 | |
[Doc] 修复新模型量化调优指南、权重量化使用指南、敏感层分析使用指南资料问题 Co-authored-by: xyxin_006<xiayingxin1@huawei.com> # message auto-generated for no-merge-commit merge: !881 merge doc/process_usage_issue into master [Doc] 修复新模型量化调优指南、权重量化使用指南、敏感层分析使用指南资料问题 Created-by: xyxin_006 Commit-by: xyxin_006 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 协议变更。 **输出件变更（按需）：** 无 **非兼容变更（按需）：** 无 > 备注：用户指南文件重命名 usage_sensitive_layer_wise_analysis.md → usage_sensitive_layer_analysis.md，已同步更新站内链接与 mkdocs.yml；对外书签若指向旧路径需改用新路径。 **SIG 评审结论（按需）：** 无 ## 2. 修改描述 **修改背景（可选）：** 新模型量化调优流程、权重量化使用指南、敏感层分析（linear / layer / attn）使用指南在资料评审中存在表述不清、标点与并列关系不规范、流程节点缺失、指标推荐未说明选取方式、接口文档仍指向章节锚点或旧文件名等问题，影响按指南落地执行。 **修改目的：** 按评审意见整改上述中文用户指南与关联引用，使流程步骤、命令行表述、校准集约定、指标选取与接口文档链接可直接指导实践，并与 CLI scope 命名对齐。 **修改内容：** - docs/流程：优化《新模型量化调优流程》前置条件、步骤表述、异常处置与术语（模型适配按 LLM / VLM / SD 分列），统一「精度与性能」等并列用语，修正 vLLM Ascend 量化适配中文文档链接。 - docs/流程：优化《权重量化使用指南》路径说明、配置协议权威链接（改挂 api_reference/config/task/*）、格式选型与验收/安全等表述。 - docs/流程：优化 linear / layer / attn 敏感层分析使用指南（补充「命令行」、校准集进流程图、与量化所用校准集一致、审计记录变量统一、后续操作用完整 quant 命令行表述、异常处置写清再执行分析命令等）；指标「推荐」列改为如何选取；修正 QKV 成组策略表述。 - docs/导航：将层级敏感层分析指南重命名为 usage_sensitive_layer_analysis.md（对齐 analyze layer），并更新 mkdocs.yml、用户指南索引、API 与知识库交叉引用。 - docs/知识库：在量化算法 README 与相关 usage 中同步层级指南新路径（变基吸收 upstream 算法文档整改后保留新文件名）。 **概念域参考（填写提示）：** - cli：命令行 quant / analyze / tune - app：最佳实践量化、量化分析、精度反馈自动调优等 - core：算法、量化服务、调度、张量量化、调优策略、最佳实践、上下文等 - infra：模型适配、调优计划/历史/缓存、测评服务等 - utils：日志、错误处理、插件等 ## 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 测试用例看护（N/A：纯文档变更，无代码逻辑改动） - [x] 是否需要添加冒烟：否 See merge request: Ascend/msmodelslim!881 | 1 个月前 | |
[Doc]优化资料文档：FAQ分类索引重构与README易用性提升 Co-authored-by: LeeQT<liqitong@huawei.com> # message auto-generated for no-merge-commit merge: !851 merge docs0817 into master [Doc]优化资料文档：FAQ分类索引重构与README易用性提升 Created-by: LeeQT Commit-by: LeeQT Merged-by: ascend-robot Description: # PR 提交说明 ## 1. 影响面评估 **接口变更（按需）：** 无 > 备注：涉及 CLI、API、YAML 等请在此项补充说明。 **输出件变更（按需）：** 无 > 备注：涉及导出格式、产物路径等请在此项补充说明。 **非兼容变更（按需）：** 无 > 备注：若有非兼容变更请说明迁移方式。 **SIG 评审结论（按需）：** 无 > 提醒：非兼容、安全风险等高危 PR 须经 SIG 评审后合入；无则保留「无」。 ## 2. 修改描述 **修改背景（可选）：** msModelSlim 资料文档存在 FAQ 单篇过长、README 功能章节与业务流程对应关系不直观、部分文档链接失效等问题，新手用户检索与上手成本较高。 **修改目的：** 提升资料文档的易用性与可维护性：将 FAQ 重构为「统一索引 + 分类子文档」结构并补充 AI 可读元数据，优化 README 业务流程引导，统一文档模板与提示样式，便于用户检索与后续维护。 **修改内容：**（按「概念 - 变化」分条） - docs/support：FAQ 重构为统一分类索引（faq.md），新增 5 篇分类子文档（安装依赖/运行资源/硬件兼容/精度调优·预留/部署推理·预留/告警提示），各子文档头部新增 AI 可读元数据（title/description/keywords），便于 AI 检索并降低 token 开销 - docs：README.md 补充 pip 安装示例；"功能介绍"重构为"使用指南"，按业务流程对应工具/功能并给出文档链接；各章节改为引导式描述 + 直达链接 - docs：index.md 核心优势章节改为结构化列表 - docs：docs_standards/02_process_guide_template.md 流程指南模板重排 - docs：knowledge_base/model/README.md 提示样式统一为引用块 - infra：.pre-commit-config.yaml 优化 gitleaks hook 的二进制查找逻辑并增加 --staged 参数 ## 3. 功能验证 冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。 - [x] 功能自验（N/A：纯文档/配置变更，无功能逻辑改动） - [ ] 本地自验用例截图（N/A：无代码变更，无需截图） **复现步骤（可选）：** bash # 纯资料变更，无复现命令；已本地核对文档相对链接与目录结构一致性 ## 4. 自检（请逐项确认，不适用标 N/A） **典型安全编码问题** - [x] 是否已校验外部数据（N/A：无代码变更） - [x] 是否未采集或打印敏感信息（是） - [x] 是否已正确设置文件权限（N/A） - [x] 是否充分考虑浮点运算溢出、除零等异常场景（N/A） - [x] 是否已对正则表达式做 ReDos 检查（N/A） **DT** - [x] 是否具备 UT 测试用例看护（否：纯文档/配置变更，无需 UT） - [x] 是否需要添加冒烟：否 See merge request: Ascend/msmodelslim!851 | 1 个月前 | |
【docs】资料架构重构，并将资料托管至readthedocs。 Co-authored-by: keith_wa<keith_wwa@163.com> # message auto-generated for no-merge-commit merge: !109 merge pr_docs_re_copy into master 【docs】资料架构重构，并将资料托管至readthedocs。 Created-by: keith_wa Commit-by: keith_wa Merged-by: ascend-robot Description: 1. 动机 (Motivation) 内容上： 优化导航结构：原目录结构逻辑不清晰、目录层级深且链接复杂。 提升阅读体验：原 traditional_quantization_v0 目录下存在 20+ 个零散文档，内容分布碎片化，用户难以快速建立完整的技术全景认知。 消除内容冗余：多个文档之间存在重复的依赖说明、操作流程及参数介绍，增加了维护成本及版本不一致的风险。 呈现上： 提供专业资料托管：原docs/目录结构不清晰、目录名/文档名不直观（英文），跳转繁琐且无搜索功能。 2. 修改点 (Changes) 2.1 重新梳理目录结构  2.2. 文档整合与重构 V0及传统量化核心文档合并：将 20 多个零散文档按功能维度深度整合为 10篇核心指南： # V0框架文档导航（已停止演进） 本目录文档按模型类型与任务场景重排，便于按需求快速定位。 ## 一、传统模型量化与校准 - [传统模型量化与校准](traditional_model_quantization_and_calibration.md) - 包含 PyTorch/ONNX/MindSpore 训练后量化与 QAT。 ## 二、大模型量化与压缩 - [大模型量化与校准](foundation_model_quantization_and_calibration.md) - 包含低显存量化、混合校准数据集、FA3 量化。 - [压缩与结构优化（大模型为主）](foundation_model_compression.md) - 包含稀疏量化与权重压缩、长序列压缩、权重压缩流程、低秩分解。 ## 三、训练加速与模型改造 - [训练加速与模型改造](pruning_and_distillation.md) - 包含重要性剪枝、Transformer 剪枝、Sparse tool、模型蒸馏。 - [稀疏加速训练](sparse_acceleration_training.md) - 包含宽度扩增与深度扩增模型的稀疏训练加速流程。 ## 四、工具与生态适配 - [辅助工具与专项指导](compression_utils.md) - 包含量化权重格式说明与 MindSpeed 适配器。 - [伪量化精度测试工具](fake_quantization_accuracy_testing_tool.md) - 包含 Precision Tool 使用方式与测试流程。 - [多模态生成模型推理优化](inference_optimization_for_multimodal_generative_model.md) - 包含 DiT 缓存优化与自适应采样优化流程。 - [常见代码示例](quantization_and_sparse_quantization_scenario_import_code_examples.md) - 包含常见量化/稀疏量化场景导入代码样例。 2.3 配置readthedocs文档托管： https://modelslim.readthedocs.io/zh-cn/latest/ 2.4 配置deepwiki： https://deepwiki.com/Keithwwa/ModelSlim 3. 验证： 3.1. gimini代码检视： https://github.com/Keithwwa/ModelSlim/pull/1 See merge request: Ascend/msmodelslim!109 | 7 个月前 |
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 4 个月前 | ||
| 1 个月前 | ||
| 7 个月前 | ||
| 1 个月前 | ||
| 1 个月前 | ||
| 7 个月前 |