| [docs] improve the docs readability
Co-authored-by: zhongzhoutan<1710115119@bjmu.edu.cn>
# message auto-generated for no-merge-commit merge:
!309 merge docs/docs-improvement into master
[docs] improve the docs readability
Created-by: tangxuanya
Commit-by: zhongzhoutan
Merged-by: ascend-robot
Description: 感谢您贡献的Pull Request！
在提交之前，请务必阅读 [CONTRIBUTING.md](https://gitcode.com/Ascend/msmodelslim/blob/master/CONTRIBUTING.md)。
Thanks for sending a pull request!
BEFORE SUBMITTING, PLEASE READ [CONTRIBUTING.md](https://gitcode.com/Ascend/msmodelslim/blob/master/CONTRIBUTING.md).
## 一、Bug 修复（正确性问题）
| 文件 | 修复内容 |
|------|----------|
| [SessionConfig.md](../docs/zh/python_api_v0/unified_multimodal_generation_apis/SessionConfig.md) | act_method 可选值 'mixed' → 'mix'（已通过源码枚举 ACT_METHOD 验证） |
| [SessionConfig.md](../docs/zh/python_api_v0/unified_multimodal_generation_apis/SessionConfig.md) | 代码示例中 output_path="./" 后缺少逗号，已补全 |
| [[onnx]run().md](../docs/zh/python_api_v0/quantization_apis/[onnx]post_training_quantization/run().md) | 补充了被使用但未定义的变量 input_model_path |
| [traditional_model_quantization_and_calibration.md](../docs/zh/feature_guide/traditional_quantization_v0/traditional_model_quantization_and_calibration.md) | 将 from ascend_utils.common.security import SafeWriteUmask 移至实际使用它的代码块（diffusers 示例），而非错误放置在 resnet50 示例中 |
| [典型模型量化支持特性设计说明书.md](../docs/zh/design/典型模型量化支持特性设计说明书.md) | 修复两处错误的 CLI 子命令：msmodelslim quantize → msmodelslim quant |
| [usage.md（一键量化）](../docs/zh/feature_guide/quick_quantization_v1/usage.md) | 修复 tag 参数说明语法错误："则于用户交互" → "则与用户交互，询问是否"（缺少谓语动词） |
| [quantization_quick_start.md](../docs/zh/getting_started/quantization_quick_start.md) | 同上，tag 参数说明语法修复 |
---
## 二、锚点与链接修复
| 文件 | 修复内容 |
|------|----------|
| [integrating_multimodal_understanding_model.md](../docs/zh/developer_guide/integrating_multimodal_understanding_model.md) | 所有带编号的标题锚点（如 #5-校准数据准备、#34-辅助方法...）已更新为与去编号后的标题一致（如 #校准数据准备、#辅助方法...） |
| [sparse_quantization_accuracy_tuning_cases.md](../docs/zh/case_studies/sparse_quantization_accuracy_tuning_cases.md) | 修复链接目标失效问题 |
| [w8a8_accuracy_tuning_policy.md](../docs/zh/case_studies/w8a8_accuracy_tuning_policy.md) | 修复链接目标失效问题 |
---
## 三、内容优化——integrating_multimodal_understanding_model.md
- 移除所有标题的 1./2./3.x 编号前缀（共 14 处），与文档风格保持一致
- 新增术语内联说明：Merger、DeepStack、PatchMerger、MoE、IterSmooth、QuaRot
- 纯文本文件路径改为可点击的 GitCode 链接（model_adapter.py、__init__.py、moe_utils.py 等）
- 校准数据章节（原第 5 节）从约 60 行详细说明精简为一句话 + 指向 usage.md#dataset 的链接，消除内容重复
- 新增 YAML 配置字段说明表格，对每个 spec 配置块进行解释，并附 linear_quant.md 和 usage.md 的参考链接
- FAQ 节标题去编号，锚点同步更新
- 附录：修复一处微小代码错误；精简重复的 VLM 数据加载器链接
---
## 四、内容优化——量化算法文档
| 文件 | 变更内容 |
|------|----------|
| [fa3_quant.md](../docs/zh/quantization_algorithms/quantization_algorithms/fa3_quant.md) | 删除"使用说明"节中的重复 YAML 配置块；将使用说明合并至"YAML配置示例"节 |
| [float_sparse.md](../docs/zh/quantization_algorithms/quantization_algorithms/float_sparse.md) | 同上，删除重复 YAML 块及空的"模型适配"节 |
| [gptq.md](../docs/zh/quantization_algorithms/quantization_algorithms/gptq.md) | 在 YAML 示例前补充"作为Processor使用"引导语 |
| [histogram_activation_quantization.md](../docs/zh/quantization_algorithms/quantization_algorithms/histogram_activation_quantization.md) | 删除重复 YAML；代码路径改为 GitCode 链接；字段表格重构为 Histogram 专属约束表；修复 FAQ 中量化器查找说明，改为正确路径引用 |
| [kvcache_quant.md](../docs/zh/quantization_algorithms/quantization_algorithms/kvcache_quant.md) | 合并两处重复 YAML 配置块 |
| [minmax.md](../docs/zh/quantization_algorithms/quantization_algorithms/minmax.md) | 代码路径改为 GitCode 链接；功能介绍重构为 3 个子节；YAML 示例补全所有参数；字段说明表格扩充 |
| [pdmix.md](../docs/zh/quantization_algorithms/quantization_algorithms/pdmix.md) | 统一 per-token/per-tensor 写法为 ` per_token / per_tensor `（代码格式 + 下划线风格），全文一致 |
---
## 五、内容优化——quantization_result.md
- 文件目录树及说明表格中新增 optional/quarot.safetensors 条目
- 量化权重文件名从 quant_model_weight_w8a8.safetensors 泛化为 quant_model_weight_{quant_type}.safetensors，并附说明
- 删除冗余的"注意"提示块（信息已移入表格）
- 所有带编号章节标题（#### 1. … #### 17.）去掉编号
- 新增"QuaRot 导出结果"完整章节，包含目录结构、文件说明表、quant_model_description.json JSON 结构示例及使用场景说明
---
## 六、example/ 目录 README 修复
| 文件 | 变更内容 |
|------|----------|
| [Llama/README.md](../example/Llama/README.md) | model_type 参数说明扩展，明确 llama3.1_fp（基础模型）和 llama3.1_instruct（Instruct 模型）；为全部 5 条 LLaMA3.1 基础模型命令补加 --model_type llama3.1_fp 参数 |
| [Qwen3-Next/README.md](../example/Qwen3-Next/README.md) | transformers 版本要求说明改写；标题去编号；占位符格式改为 ` ${MODEL_PATH} ` 风格 |
| [GLM/README.md](../example/GLM/README.md) | "L自动回退等级" → "自动回退等级"（多余字符修复） |
| [HunYuan/README.md](../example/HunYuan/README.md) | "HunYuan" → "Hunyuan"（官方大小写拼写） |
| [GLM-4.1V/README.md](../example/multimodal_vlm/GLM-4.1V/README.md) | 首次出现"RLCS"时补充全称"基于课程采样的强化学习" |
| [example/README.md](../example/README.md) | 删除空的"快速开始"节 |
---
## 七、其他文档零散修复
| 文件 | 变更内容 |
|------|----------|
| [dir_structure.md](../docs/zh/dir_structure.md) | "Smooth Quant" → "SmoothQuant"（官方名称） |
| [auto_precision_tuning/usage.md](../docs/zh/feature_guide/auto_precision_tuning/usage.md) | device 参数说明：删除指向失效链接的描述，改为"数据并行（Data Parallel，DP）逐层量化"的简明说明 |
| [analyze_api_usage.md](../docs/zh/feature_guide/sensitive_layer_analysis/analyze_api_usage.md) | 删除对 trust_remote_code=False 含义的错误/混淆说明 |
| [mindspeed_adapter.md](../docs/zh/feature_guide/traditional_quantization_v0/mindspeed_adapter.md) | 删除 dev_type='npu' 参数上具有误导性的内联注释 |
| [foundation_model_support_matrix.md](../docs/zh/model_support/foundation_model_support_matrix.md) | 精简脚注 4（删除 vLLM 绕行方案描述） |
| [典型模型量化支持特性设计说明书.md](../docs/zh/design/典型模型量化支持特性设计说明书.md) | 新增 16 条缩写词表；修复 Use Case 名称拼写错误 |
| [自动调优加速特性设计说明书.md](../docs/zh/design/自动调优加速特性设计说明书.md) | 修复 Use Case 名称拼写错误 |
| [release_notes.md](../docs/zh/appendix/release_notes.md) | 将空的"无"替换为适当内容 |
| [README.md](../README.md) | 开发者指南部分新增多模态模型接入链接 |
---
## 总体评价
本次提交仅涉及文档修改，改动范围清晰、目的明确。重点亮点：
- **修复 7 处正确性 Bug**：错误 CLI 命令、错误枚举值、缺失变量、错位导入、失效锚点、语法错误
- **消除 5+ 个文件中的内容重复**：量化算法文档及多模态接入指南均有大量冗余内容被精简
- **统一去除标题编号**：4+ 个文件中的章节编号被一致移除，符合项目文档风格规范
- **无功能性变更引入**：所有锚点目标变更均与去编号后的新标题保持对应，未引入回归问题
See merge request: Ascend/msmodelslim!309 | 1 个月前 |
