docs: update project documentation in README.
This commit is contained in:
61
README.md
61
README.md
@@ -38,10 +38,9 @@ data_analysis_agent/
|
||||
├── 📄 requirements.txt # 项目依赖
|
||||
├── 📄 .env # 环境变量配置
|
||||
└── 📁 outputs/ # 分析结果输出目录
|
||||
└── session_[时间戳]/ # 每次分析的独立会话目录
|
||||
├── *.png # 生成的图表
|
||||
├── 最终分析报告.md # Markdown报告
|
||||
└── 最终分析报告.docx # Word报告
|
||||
└── session_[时间戳]/ # 每次分析的独立会话目录
|
||||
├── *.png # 生成的图表
|
||||
└── 最终分析报告.md # Markdown报告
|
||||
```
|
||||
|
||||
## 📊 数据分析流程图
|
||||
@@ -111,7 +110,6 @@ sequenceDiagram
|
||||
- **多阶段分析**：数据探索 → 清洗检查 → 分析可视化 → 图片收集 → 报告生成
|
||||
- **错误自愈**：自动检测并修复常见错误（编码、列名、数据类型等）
|
||||
- **上下文保持**：Notebook环境中变量和状态在分析过程中持续保持
|
||||
- **双重日志**：支持同时输出日志到终端和文件，便于调试和记录
|
||||
|
||||
### 📋 多格式报告
|
||||
|
||||
@@ -125,9 +123,9 @@ sequenceDiagram
|
||||
|
||||
```bash
|
||||
# 克隆项目
|
||||
git clone https://github.com/li-xiu-qi/data_analysis_agent.git
|
||||
git clone http://jeason.online:3000/zhaojie/iov_data_analysis_agent.git
|
||||
|
||||
cd data_analysis_agent
|
||||
cd iov_data_analysis_agent
|
||||
|
||||
# 安装依赖
|
||||
pip install -r requirements.txt
|
||||
@@ -135,7 +133,7 @@ pip install -r requirements.txt
|
||||
|
||||
### 2. 配置API密钥
|
||||
|
||||
创建`.env`文件：
|
||||
创建`.env`及`llm_config.py`文件：
|
||||
|
||||
```bash
|
||||
# OpenAI API配置
|
||||
@@ -158,10 +156,11 @@ from config.llm_config import LLMConfig
|
||||
llm_config = LLMConfig()
|
||||
agent = DataAnalysisAgent(llm_config)
|
||||
|
||||
# 开始分析
|
||||
# 开始分析（input中输入你想要的内容。并在运行前调整提示词中的报告格式及分析要求）
|
||||
files = ["your_data.csv"]
|
||||
#excel文件同样支持
|
||||
report = agent.analyze(
|
||||
user_input="分析销售数据，生成趋势图表和关键指标",
|
||||
user_input="分析车联网运维工单的数据，帮我汇总生成一份用于汇报使用的，运维工单报告销售数据，XXXXXXXXXX",
|
||||
files=files
|
||||
)
|
||||
|
||||
@@ -188,25 +187,24 @@ report = quick_analysis(
|
||||
|
||||
## 📊 使用示例
|
||||
|
||||
以下是分析贵州茅台财务数据的完整示例：
|
||||
|
||||
```python
|
||||
# 示例：茅台财务分析
|
||||
files = ["贵州茅台利润表.csv"]
|
||||
# 示例：工单健康度分析
|
||||
files = ["iov.csv"]
|
||||
report = agent.analyze(
|
||||
user_input="基于贵州茅台的数据，输出五个重要的统计指标，并绘制相关图表。最后生成汇报给我。",
|
||||
user_input="基于所有的运维工单，输出XXXX等重要的统计指标，并绘制相关图表。最后生成汇报给我。",
|
||||
files=files
|
||||
)
|
||||
```
|
||||
|
||||
**生成的分析内容包括：**
|
||||
|
||||
- 📈 营业总收入趋势图
|
||||
- 💰 净利润率变化分析
|
||||
- 📊 利润构成分析图表
|
||||
- 💵 每股收益变化趋势
|
||||
- 📋 营业成本占比分析
|
||||
- 📄 综合分析报告
|
||||
- 工单月度/周度/日度趋势图
|
||||
- 问题类型及车型分布
|
||||
- 问题模块分析图表
|
||||
- 问题处理时长分析图表
|
||||
- 问题模块汇总图表
|
||||
-
|
||||
|
||||
## 🎨 流程可视化
|
||||
|
||||
@@ -244,8 +242,8 @@ class LLMConfig:
|
||||
api_key: str = os.environ.get("OPENAI_API_KEY", "")
|
||||
base_url: str = os.environ.get("OPENAI_BASE_URL", "https://api.openai.com/v1")
|
||||
model: str = os.environ.get("OPENAI_MODEL", "gpt-4")
|
||||
max_tokens: int = 131072 # 支持长上下文模型
|
||||
temperature: float = 0.5
|
||||
max_tokens: int = 4000
|
||||
temperature: float = 0.1
|
||||
```
|
||||
|
||||
### 执行器配置
|
||||
@@ -284,8 +282,7 @@ ALLOWED_IMPORTS = {
|
||||
### 安全限制
|
||||
|
||||
- 🔒 仅支持预定义的数据分析库
|
||||
- 🔒 严禁使用 `open()` 写入文件（除保存图片/JSON外），所有中间数据应优先保存在DataFrame变量中
|
||||
- 🔒 不允许文件系统操作（除图片保存即日志记录）
|
||||
- 🔒 不允许文件系统操作（除图片保存）
|
||||
- 🔒 不支持网络请求（除LLM调用）
|
||||
|
||||
### 性能考虑
|
||||
@@ -326,20 +323,6 @@ A: 可以在Mermaid代码块中添加样式定义，或使用不同的图表类
|
||||
|
||||
分析过程中的错误信息会保存在会话目录中，便于调试和优化。
|
||||
|
||||
## 🤝 贡献指南
|
||||
|
||||
欢迎贡献代码和改进建议！
|
||||
|
||||
1. Fork 项目
|
||||
2. 创建功能分支
|
||||
3. 提交更改
|
||||
4. 推送到分支
|
||||
5. 创建Pull Request
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
本项目基于MIT许可证开源。详见[LICENSE](LICENSE)文件。
|
||||
|
||||
## 🔄 更新日志
|
||||
|
||||
### v1.0.0
|
||||
@@ -354,6 +337,6 @@ A: 可以在Mermaid代码块中添加样式定义，或使用不同的图表类
|
||||
|
||||
<div align="center">
|
||||
|
||||
**🚀 让数据分析变得更智能、更简单！**
|
||||
**简化数据分析入门门槛，让数据分析变得更智能、更简单！**
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user