CostPrediction/docs/dev/run.md

165 lines
2.7 KiB
Markdown

# 装备成本估算系统运行说明
## 一、开发环境配置
### 1. 系统要求
- Linux/macOS/Windows
- Python 3.8+
- MySQL 8.0+
### 2. 安装依赖
```bash
# 创建并激活虚拟环境
python3 -m venv venv
source venv/bin/activate # Linux/macOS
# 或
.\venv\Scripts\activate # Windows
# 安装依赖包
pip install -r requirements.txt
```
## 二、初始化系统
### 1. 创建必要目录
```bash
mkdir -p {logs,data,models}
```
### 2. 配置数据库
```bash
# 执行数据库初始化脚本
mysql -u root -p < src/schema.sql
# [可选] 导入测试数据(仅用于开发环境)
mysql -u root -p equipment_cost_db < src/init_data.sql
```
### 3. 环境配置
创建 `.env` 文件:
```ini
MYSQL_HOST=localhost
MYSQL_USER=root
MYSQL_PASSWORD=123456
MYSQL_DATABASE=equipment_cost_db
```
## 三、启动服务
### 1. 开发模式
```bash
# 启动开发服务器
python run.py
```
### 2. 测试 API
```bash
# 运行 API 测试
python src/test_api.py
```
## 四、开发调试
### 1. 日志查看
```bash
# API 日志
tail -f logs/api.log
# 测试日志
tail -f logs/test_api.log
# 训练日志
tail -f logs/training.log
```
### 2. 数据库调试
```sql
-- 检查数据表
SHOW TABLES;
-- 查看示例数据
SELECT * FROM equipment LIMIT 5;
```
### 3. API 测试
```bash
# 测试 API 根路由
curl http://localhost:5001/api/
# 测试预测接口
curl -X POST http://localhost:5001/api/predict \
-H "Content-Type: application/json" \
-d '{
"type": "巡飞弹",
"length_m": 1.3,
"width_m": 0.23,
"height_m": 0.23,
"weight_kg": 12.5,
"max_range_km": 40
}'
```
## 五、注意事项
1. 开发环境配置
- 使用虚拟环境隔离依赖
- 保持日志目录可写权限
- 定期清理日志文件
2. 数据库使用
- 使用 UTF-8 字符集
- 定期备份数据
- 避免直接修改生产数据
3. 代码调试
- 查看详细日志输出
- 使用测试数据验证功能
- 遵循代码规范
## 六、常见问题
1. 数据库连接错误
- 检查 MySQL 服务状态
- 验证数据库用户名密码
- 确认数据库字符集设置
2. API 访问问题
- 检查服务是否正常运行
- 验证请求格式是否正确
- 查看错误日志信息
3. 模型相关问题
- 确保训练数据完整性
- 检查模型文件权限
- 验证预测结果合理性
## 七、开发建议
1. 代码管理
- 使用版本控制
- 遵循项目结构
- 及时更新文档
2. 测试规范
- 运行完整测试套件
- 验证各个功能模块
- 记录测试结果
3. 安全注意
- 使用安全的数据库密码
- 避免敏感信息提交
- 保护测试数据安全
注:生产环境部署请参考 `deploy.md`