docs: 更新README为当前架构(SQLite/Flask),合并启动说明
This commit is contained in:
parent
2d01c763a1
commit
b6b072d844
88
README.md
88
README.md
@ -1,100 +1,92 @@
|
||||
# 装备成本预测系统
|
||||
|
||||
基于机器学习的装备成本预测系统,支持多种预测模型和数据分析功能。
|
||||
基于机器学习的装备成本预测系统,支持火箭炮和巡飞弹两种装备类型的成本预测与数据分析。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 多模型成本预测
|
||||
- 机器学习模型 (XGBoost, LightGBM, RandomForest)
|
||||
- PLS 回归模型
|
||||
- 多模型成本预测 (XGBoost, LightGBM, RandomForest, GBM, PyTorch NN, PLS)
|
||||
- 特征分析与数据可视化
|
||||
- 算法对比演示
|
||||
- 生产商分析
|
||||
- 数据集管理
|
||||
- 模型训练与评估
|
||||
|
||||
## 系统要求
|
||||
## 技术栈
|
||||
|
||||
- Python >= 3.9, < 3.12
|
||||
- MySQL >= 8.0
|
||||
- 其他依赖见 pyproject.toml
|
||||
- 后端:Python 3.9 ~ 3.11 + Flask
|
||||
- 数据库:SQLite(内置,零配置)
|
||||
- 前端:Vue 3 + Element Plus + ECharts
|
||||
- 机器学习:scikit-learn, XGBoost, LightGBM(PyTorch 可选)
|
||||
|
||||
## 快速开始
|
||||
|
||||
1. 克隆项目
|
||||
|
||||
```bash
|
||||
git clone [repository-url]
|
||||
cd cost-prediction
|
||||
```
|
||||
|
||||
2. 安装依赖
|
||||
|
||||
```bash
|
||||
# 1. 安装依赖
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
3. 配置数据库
|
||||
# 2. 初始化派生特征数据(首次必须执行)
|
||||
python -m scripts.calculate_features
|
||||
|
||||
```bash
|
||||
[Windows]
|
||||
scripts/setup_env.ps1
|
||||
|
||||
[Linux/macOS]
|
||||
scripts/setup_env.sh
|
||||
```
|
||||
|
||||
4. 运行系统
|
||||
|
||||
```bash
|
||||
# 3. 启动服务
|
||||
python run.py
|
||||
```
|
||||
|
||||
浏览器打开 **http://127.0.0.1:5001**。
|
||||
|
||||
## 常用命令
|
||||
|
||||
```bash
|
||||
# 安装开发依赖(含 pytest, black, mypy)
|
||||
pip install -e ".[dev]"
|
||||
|
||||
# 安装可选 PyTorch(神经网络训练需要)
|
||||
pip install -e ".[torch]"
|
||||
|
||||
# 运行测试
|
||||
python -m pytest tests/
|
||||
|
||||
# 代码格式化
|
||||
black src/ tests/
|
||||
```
|
||||
|
||||
## API 文档
|
||||
|
||||
### 预测接口
|
||||
|
||||
- POST `/api/predict` - 使用最优机器学习模型预测
|
||||
- POST `/api/predict` - 使用最优模型预测
|
||||
- POST `/api/pls/predict` - 使用 PLS 模型预测
|
||||
|
||||
### 数据管理
|
||||
|
||||
- GET `/api/data` - 获取装备数据列表
|
||||
- POST `/api/data/import` - 导入 Excel 数据
|
||||
- GET `/api/data/details/<id>` - 获取装备详情
|
||||
- PUT `/api/data/<id>` - 更新装备数据
|
||||
|
||||
### 数据集管理
|
||||
|
||||
- GET `/api/datasets` - 获取数据集列表
|
||||
- POST `/api/datasets` - 创建数据集
|
||||
- GET `/api/datasets/<id>` - 获取数据集详情
|
||||
- PUT `/api/datasets/<id>` - 更新数据集
|
||||
- DELETE `/api/datasets/<id>` - 删除数据集
|
||||
|
||||
### 模型管理
|
||||
|
||||
- GET `/api/models` - 获取模型列表
|
||||
- POST `/api/train` - 训练模型
|
||||
- POST `/api/models/<id>/activate` - 激活模型
|
||||
- DELETE `/api/models/<id>` - 删除模型
|
||||
|
||||
### 分析功能
|
||||
|
||||
- POST `/api/analyze-features` - 特征分析
|
||||
- POST `/api/analyze-manufacturers` - 生产商分析
|
||||
- POST `/api/demo/algorithms` - 查看可用算法
|
||||
- POST `/api/demo/run` - 运行算法演示
|
||||
|
||||
## 开发指南
|
||||
## 前端开发
|
||||
|
||||
详细的开发文档请参考 `docs/dev/` 目录:
|
||||
|
||||
- requirements.md - 项目需求文档
|
||||
- debug.md - 调试指南
|
||||
|
||||
## 测试
|
||||
|
||||
运行测试:
|
||||
如需修改前端代码:
|
||||
|
||||
```bash
|
||||
python src/test_api.py
|
||||
cd frontend
|
||||
npm install
|
||||
npm run serve # 开发模式(热更新)
|
||||
npm run build # 构建生产版本
|
||||
```
|
||||
|
||||
## 许可证
|
||||
|
||||
23
STARTUP.md
23
STARTUP.md
@ -1,23 +0,0 @@
|
||||
# 成本预测系统 - 启动说明
|
||||
|
||||
## 环境要求
|
||||
- Python 3.9 ~ 3.11
|
||||
|
||||
## 启动步骤
|
||||
|
||||
```bash
|
||||
# 1. 安装依赖
|
||||
pip install -e .
|
||||
|
||||
# 2. 初始化派生特征数据(首次必须执行)
|
||||
python -m scripts.calculate_features
|
||||
|
||||
# 3. 启动服务
|
||||
python run.py
|
||||
```
|
||||
|
||||
浏览器打开 **http://127.0.0.1:5001** 即可。
|
||||
|
||||
## 附注
|
||||
- 数据库为 SQLite,首次启动自动创建,无需安装配置
|
||||
- 如修改前端代码,需安装 Node.js 后在 `frontend/` 目录执行 `npm install && npm run build`
|
||||
Loading…
Reference in New Issue
Block a user