Chrisyichuan commited on
Commit
91ea92f
·
1 Parent(s): 745efa8

upd readme

Browse files
Files changed (1) hide show
  1. readme.md +126 -1
readme.md CHANGED
@@ -1,6 +1,131 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  uv sync
 
 
 
2
 
 
 
 
3
  python main.py --mode data --samples 50 --urban --no-indoor
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
 
 
5
 
6
- python main.py --mode benchmark --models gpt-4o --samples 5
 
1
+ # Simple G AI Bot
2
+
3
+ A versatile AI bot for image analysis and dataset curation with support for multiple AI models.
4
+
5
+ ## Features
6
+
7
+ - **Dataset Curation**: Generate and curate image datasets
8
+ - **Single Image Analysis**: Benchmark different AI models on individual images
9
+ - **Agentic Analysis**: Multi-step AI reasoning and analysis
10
+ - **Multiple AI Providers**: Support for OpenAI, Anthropic, and Google AI
11
+
12
+ ## Quick Start
13
+
14
+ ### 1. Setup Environment
15
+
16
+ ```bash
17
+ cd simple_G_ai_bot
18
+ ```
19
+
20
+ Create a `.env` file in the project root:
21
+
22
+ ```bash
23
+ # .env
24
+ OPENAI_API_KEY=your_openai_api_key_here
25
+ ANTHROPIC_API_KEY=your_anthropic_api_key_here
26
+ GOOGLE_API_KEY=your_google_api_key_here
27
+ ```
28
+
29
+ ### 2. Install Dependencies
30
+
31
+ ```bash
32
  uv sync
33
+ ```
34
+
35
+ ### 3. Usage Examples
36
 
37
+ #### Dataset Curation
38
+ Generate 50 urban outdoor samples:
39
+ ```bash
40
  python main.py --mode data --samples 50 --urban --no-indoor
41
+ ```
42
+
43
+ #### Single Image Analysis
44
+ Benchmark GPT-4o on 5 samples:
45
+ ```bash
46
+ python main.py --mode benchmark --models gpt-4o --samples 5
47
+ ```
48
+
49
+ #### Agentic Analysis
50
+ Run multi-step analysis with Gemini:
51
+ ```bash
52
+ python main.py --mode agent --model gemini-2.5-pro --steps 10 --samples 5
53
+ ```
54
+
55
+ ## Configuration
56
+
57
+ ### Environment Variables
58
+
59
+ | Variable | Description | Required |
60
+ |----------|-------------|----------|
61
+ | `OPENAI_API_KEY` | OpenAI API key for GPT models | Optional |
62
+ | `ANTHROPIC_API_KEY` | Anthropic API key for Claude models | Optional |
63
+ | `GOOGLE_API_KEY` | Google AI API key for Gemini models | Optional |
64
+
65
+ ### Command Line Options
66
+
67
+ #### Common Options
68
+ - `--mode`: Operation mode (`data`, `benchmark`, `agent`)
69
+ - `--samples`: Number of samples to process (default: 10)
70
+
71
+ #### Data Mode Options
72
+ - `--urban`: Focus on urban environments
73
+ - `--no-indoor`: Exclude indoor scenes
74
+
75
+ #### Benchmark Mode Options
76
+ - `--models`: AI model to use (e.g., `gpt-4o`, `claude-3`, `gemini-pro`)
77
+
78
+ #### Agent Mode Options
79
+ - `--model`: AI model for agentic analysis
80
+ - `--steps`: Number of reasoning steps (default: 5)
81
+
82
+ ## Supported Models
83
+
84
+ - **OpenAI**: GPT-4o, GPT-4, GPT-3.5-turbo
85
+ - **Anthropic**: Claude-3-opus, Claude-3-sonnet, Claude-3-haiku
86
+ - **Google**: Gemini-2.5-pro, Gemini-pro, Gemini-pro-vision
87
+
88
+ ## Requirements
89
+
90
+ - Python 3.8+
91
+ - UV package manager
92
+ - Valid API keys for desired AI providers
93
+
94
+ ## Installation
95
+
96
+ 1. Clone the repository
97
+ 2. Navigate to project directory: `cd simple_G_ai_bot`
98
+ 3. Create `.env` file with your API keys
99
+ 4. Install dependencies: `uv sync`
100
+ 5. Run the bot with desired mode and options
101
+
102
+ ## Examples
103
+
104
+ ### Basic Dataset Generation
105
+ ```bash
106
+ python main.py --mode data --samples 20
107
+ ```
108
+
109
+ ### Urban Scene Analysis
110
+ ```bash
111
+ python main.py --mode data --samples 30 --urban --no-indoor
112
+ ```
113
+
114
+ ### Model Comparison
115
+ ```bash
116
+ python main.py --mode benchmark --models gpt-4o --samples 10
117
+ python main.py --mode benchmark --models claude-3-opus --samples 10
118
+ ```
119
+
120
+ ### Advanced Agentic Workflow
121
+ ```bash
122
+ python main.py --mode agent --model gemini-2.5-pro --steps 15 --samples 3
123
+ ```
124
+
125
+ ## Security Note
126
+
127
+ ⚠️ **Important**: Never commit your `.env` file to version control. Add `.env` to your `.gitignore` file to keep your API keys secure.
128
 
129
+ ## License
130
 
131
+ MIT License - see LICENSE file for details.