diff --git a/README.md b/README.md index 66ec7c6..8890b0e 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,28 @@ -# CardioAI - 心血管疾病智能辅助系统 +# zln_test1 - 基础工程化测试仓 ## 项目概述 -本项目是一个多模块应用,集成了数据可视化(Streamlit)、机器学习预测(XGBoost/Flask)和AI语音问答(DeepSeek/cosyVoice)。 +本仓库最初用于验证 macOS M1 环境下的 Git 版本控制流程,后续将作为 **NLP 与大模型应用开发** 的基础工程化模板,重点实践代码版本管理、分支策略与远程协作。 -## 项目结构 -``` -. -├── data/ # 数据目录 -├── module1_dashboard/ # 模块1: 数据可视化仪表板(Streamlit) -├── module2_predictor/ # 模块2: 机器学习预测器(Flask) -│ └── templates/ # Flask模板目录 -├── module3_voice_assistant/ # 模块3: AI语音问答系统 -│ └── templates/ # 语音助手模板目录 -├── requirements.txt # 项目依赖 -└── README.md # 项目说明 -``` +## 技术栈 +| 类别 | 工具/技术 | +| :--- | :--- | +| **版本控制** | Git (2.39.5) | +| **开发环境** | macOS M1, Conda | +| **核心方向** | NLP, RAG, 大模型工程化 | -## 环境配置 - -### 1. 创建Conda虚拟环境 -```bash -conda create -n cardioenv python=3.10 -conda activate cardioenv -``` - -### 2. 安装依赖 -```bash -pip install -r requirements.txt -``` - -### 3. 重要文件路径配置 -根据项目要求,以下文件路径需要在本地配置: -- **数据文件**: `/Users/macbook/PycharmProjects/ai_code/data/心血管疾病.xlsx` -- **配置文件**: `/Users/macbook/PycharmProjects/ai_code/.env` - -如果路径不存在,请创建相应目录和文件。 - -## 模块说明 - -### Module 1: 数据可视化仪表板 -- 技术栈: Streamlit + Plotly -- 功能: 心血管疾病数据可视化分析 -- 位置: `module1_dashboard/` - -### Module 2: 机器学习预测器 -- 技术栈: Flask + XGBoost + scikit-learn -- 功能: 心血管疾病风险预测模型 -- 位置: `module2_predictor/` - -### Module 3: AI语音问答系统 -- 技术栈: DeepSeek API + cosyVoice + Flask -- 功能: 智能语音问答助手 -- 位置: `module3_voice_assistant/` +## 工程化规范 +1. **分支策略**:`main` (生产分支)、`dev` (开发分支)、`feature/*` (功能分支) +2. **提交规范**:`type(scope): message` + - 示例:`feat(init): 完成项目初始化与 README 编写` +3. **用户配置**:已完成提交者身份标准化配置。 ## 快速开始 -1. 按照"环境配置"步骤设置虚拟环境和安装依赖 -2. 将心血管疾病数据文件放置到指定路径 -3. 根据需要创建`.env`配置文件,包含API密钥等敏感信息 -4. 分别运行各模块进行开发测试 +```bash +# 克隆仓库 +git clone http://82.156.249.211:3000/zln123/zln_test1.git -## 依赖说明 -详细依赖见`requirements.txt`,主要包含: -- 数据处理: pandas, numpy, openpyxl -- 机器学习: scikit-learn, xgboost, joblib -- 可视化: streamlit, plotly -- Web框架: Flask -- AI集成: langchain-openai, dashscope -- 工具库: python-dotenv, requests +# 进入目录 +cd zln_test1 -## 下一步 -各模块的具体实现代码需要根据项目需求进一步开发。 \ No newline at end of file +# 创建功能分支 +git checkout -b feature/init-nlp \ No newline at end of file