Skip to content

Commit aba42cc

Browse files
committed
updated documentation
1 parent 78a39d0 commit aba42cc

File tree

4 files changed

+74
-3
lines changed

4 files changed

+74
-3
lines changed

.env.example

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# To separate your traces from other application
2-
LANGSMITH_PROJECT=new-agent
31

4-
# Add API keys for connecting to LLM providers, data sources, and other integrations here
2+
project_url=your_supabase_project_url
3+
api_key=your_supabase_api_key
4+
bucket=your_supabase_bucket_name
5+
6+
7+
OPENAI_API_KEY=your_openai_api_key
8+
LANGCHAIN_API_KEY=your_langchain_api_key
9+
LANGSMITH_TRACING=true
10+
E2B_API_KEY=your_e2b_api_key

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# AI Data Analyst
2+
3+
![AI Data Analyst Banner](https://img.shields.io/badge/AI-Data%20Analyst-blueviolet?style=for-the-badge)
4+
5+
## Overview
6+
7+
AI Data Analyst is an open-source platform designed to automate and enhance data analysis workflows using advanced AI agents. It enables seamless integration of data ingestion, processing, visualization, and reporting, empowering analysts and organizations to unlock actionable insights with minimal manual intervention.
8+
9+
---
10+
11+
## Features
12+
13+
- **Automated Data Ingestion**: Effortlessly import CSV, database, and API data sources.
14+
- **Intelligent Analysis**: Leverage AI agents for statistical analysis, anomaly detection, and predictive modeling.
15+
- **Natural Language Queries**: Interact with your data using conversational AI.
16+
- **Visualization**: Generate beautiful charts and dashboards.
17+
- **Extensible Architecture**: Modular agent system for custom workflows.
18+
- **Secure & Scalable**: Enterprise-ready with environment-based configuration and robust backend.
19+
20+
---
21+
22+
## Getting Started
23+
24+
### Prerequisites
25+
- Python 3.11+
26+
- `pip`
27+
### Installation
28+
29+
```bash
30+
# Clone the repository
31+
$ git clone https://github.com/pushpitkamboj/AIDataAnalyst
32+
$ cd AIDataAnalyst
33+
34+
# Install dependencies
35+
$ pip install -r pyproject.toml
36+
```
37+
38+
### Configuration
39+
40+
Copy `.env.example` to `.env` and update the values as needed:
41+
42+
```bash
43+
cp .env.example .env
44+
```
45+
46+
---
47+
48+
## Usage
49+
50+
Run the main agent:
51+
52+
```bash
53+
python main.py
54+
```
55+
56+
---
57+
58+
## Architecture
59+
60+
![AI Data Analyst Architecture](./architecture.png)
61+
62+
for more detailed documentation, refer to https://docs.google.com/presentation/d/1Y1Hrf8_KEyrQQWmSvefEJwINP4l3rXOz/edit?usp=sharing&ouid=103413741594923457323&rtpof=true&sd=true
63+
64+
---
65+

architecture.png

117 KB
Loading

graph_arch.png

Whitespace-only changes.

0 commit comments

Comments
 (0)