# llm_docs

**Repository Path**: hangangqiang/llm_docs

## Basic Information

- **Project Name**: llm_docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-30
- **Last Updated**: 2025-09-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MindSpore Golden Stick AI模型压缩工具文档

本文档集提供了MindSpore Golden Stick AI模型压缩工具的完整指南，涵盖从基础概念到高级应用的所有方面。当前工作重点是PTQ（后训练量化）算法，round_to_nearest算法已经废弃。

## 📚 文档导航

### 🚀 快速开始路径
新用户推荐阅读顺序：
1. [项目概述](01_project_overview.md) - 了解项目背景和目标
2. [安装指南](02_installation_guide.md) - 环境搭建
3. [**PTQ完整指南**](PTQ_Complete_Guide.md) ⭐ - PTQ算法完整使用指南
4. [**PTQ高级指南**](PTQ_Advanced_Guide.md) ⭐ - 高级功能和实践案例

### 📖 核心概念与算法原理
- [核心概念](04_core_concepts.md) - 量化基础知识
- [量化算法概述](Quantization_Algorithms_Overview.md) - 算法分类和选择
- [压缩算法概述](05_compression_algorithms.md) - 压缩算法总览

### 📋 PTQ算法文档
#### 完整指南
- [**PTQ完整指南**](PTQ_Complete_Guide.md) ⭐ - 包含算法原理、架构设计、配置详解、使用指南、故障排除等完整内容
- [**PTQ高级指南**](PTQ_Advanced_Guide.md) ⭐ - 高级功能、API设计、实践案例、社区贡献指南
- [**PTQ测试指南**](PTQ_Testing_Guide.md) ⭐ - 测试设计、验证报告、测试工具

#### 专项文档
- [PTQ工作流设计](PTQ_Workflow_Design.md) - 完整工作流程
- [PTQ并行策略指南](PTQ_Parallel_Strategy_Guide.md) - 并行处理策略
- [PTQ参数处理架构](PTQ_Parameter_Processing_Architecture.md) - 参数处理架构
- [PTQ软件设计](PTQ_Software_Design.md) - 详细软件设计文档

### 🔧 API参考
- [API参考](07_api_reference.md) - 基础API文档
- [PTQ源码分析](PTQ_Source_Code_Analysis.md) - 深入源码分析

### 🧪 测试与验证
- [**PTQ测试指南**](PTQ_Testing_Guide.md) ⭐ - 完整测试用例设计和现有测试用例总结

### 🤝 社区与贡献
- [编码规范指南](Coding_Standards_Guide.md) - 代码风格指南

### 🚀 模型部署与源码分析
- [模型部署](06_model_deployment.md) - 部署指南
- [PTQ源码分析](PTQ_Source_Code_Analysis.md) - 深入源码分析
- [模型源码分析](Models_Source_Analysis.md) - 模型模块分析
- [QKV FFN重构总结](QKV_FFN_Refactoring_Summary.md) - QKV/FFN重构详情
- [QKV FFN切分问题分析](QKV_FFN_Split_Issue_Analysis.md) - 切分问题分析和修复

### 📚 附录
- [附录](13_appendix.md) - 补充材料

---

## 📋 文档状态说明
- ⭐ **推荐文档**: 与当前代码实现完全一致，推荐优先阅读
- 📝 **专项文档**: 针对特定主题的深入分析

## 🔍 文档使用建议
1. **新用户**: 按照快速开始路径顺序阅读
2. **开发者**: 重点关注PTQ完整指南和高级指南
3. **维护者**: 查看测试指南和源码分析文档
4. **贡献者**: 参考编码规范指南和社区贡献部分

## 📝 文档整理说明
本文档集已经过重新整理，主要变化：
- **合并重复文档**: 将分散的PTQ相关文档合并为三个主要指南
- **去除冗余信息**: 删除过时和重复的内容
- **优化文档结构**: 建立清晰的层次关系和导航
- **更新索引**: 反映当前的文档组织结构

当前工作重点是PTQ后训练量化算法，round_to_nearest算法已经废弃。