109 lines
3.0 KiB
Markdown
Raw Permalink Normal View History

# 药店单品销售预测系统 - 文档索引
## 文档目录
### 1. [项目概述](./项目概述.md)
- 项目简介
- 系统架构
- 系统特点
- 技术栈
- 系统组件
- 未来规划
### 2. [安装配置指南](./安装配置指南.md)
- 系统要求
- 安装步骤
- 安装API服务依赖
- 验证安装
- 配置说明
- 常见问题解决
- 更新与升级
### 3. [用户操作手册](./用户操作手册.md)
- 系统概述
- 快速入门
- 功能详解
- 数据管理
- API服务使用
- 常见问题解答
- 高级使用技巧
### 4. [API参考手册](./API参考手册.md)
- API概述
- API基础信息
- 启动API服务
- 数据管理API
- 模型训练API
- 模型预测API
- 模型管理API
- 系统信息API
- API调用示例
- 错误处理
### 5. [模型架构与设计](./模型架构与设计.md)
- 模型概述
- 数据预处理流程
- Transformer模型
- 矩阵LSTM模型 (mLSTM)
- Kolmogorov-Arnold网络 (KAN)
- 模型比较
- 模型评估指标
- 模型持久化
- 未来模型优化方向
### 6. [开发者文档](./开发者文档.md)
- 项目结构
- 核心类与接口
- 模型训练接口
- 模型管理接口
- API接口
- 扩展指南
- 测试指南
- 部署指南
- 性能优化
- 贡献指南
- 常见问题解答
### 7. [项目日志](./项目日志.md)
- 项目时间线
- 版本更新历史
- 开发甘特图
- 里程碑记录
- 问题跟踪
## 文档使用指南
1. **初次使用者**:建议首先阅读[项目概述](./项目概述.md)了解系统功能,然后参考[安装配置指南](./安装配置指南.md)进行安装,最后查看[用户操作手册](./用户操作手册.md)学习如何使用系统。
2. **API用户**如果您需要通过API集成本系统请参考[API参考手册](./API参考手册.md)了解所有可用的API端点及其使用方法。
3. **开发者**:如果您计划扩展或修改系统,请先阅读[模型架构与设计](./模型架构与设计.md)了解系统的技术原理,然后参考[开发者文档](./开发者文档.md)获取开发指南。
4. **项目管理**:如需了解项目开发历程和版本更新,请查阅[项目日志](./项目日志.md)。
## 文档更新记录
| 日期 | 版本 | 更新内容 |
|------|------|----------|
| 2025-04-15 | 1.0.0 | 初始文档发布 |
| 2025-04-28 | 1.1.0 | 添加API参考手册和模型架构文档 |
| 2025-05-12 | 1.2.0 | 更新开发者文档,添加测试指南 |
| 2025-05-25 | 1.3.0 | 更新用户操作手册,添加高级使用技巧 |
| 2025-06-10 | 1.4.0 | 添加项目日志,包含甘特图和完整开发历程 |
## 文档维护
文档由项目维护团队负责更新和维护。如果您发现任何错误或有改进建议,请通过以下方式反馈:
- 在项目仓库中提交Issue
- 发送邮件至support@example.com
## 贡献文档
欢迎为文档做出贡献!如果您希望改进或扩展文档,请:
1. Fork项目仓库
2. 创建文档改进分支
3. 编写或修改文档
4. 提交拉取请求
5. 等待审核和合并