@@ -20,33 +20,44 @@ This guide explains how to build, run, and deploy the Haerae Evaluation Toolkit
2020### 2. Run the Container
2121
2222``` bash
23- # Basic run
23+ # Basic run (shows help)
2424docker run -it --rm haerae-evaluation-toolkit:latest
2525
26- # Run with environment variables
26+ # Run with environment variables and volume mounts
2727docker run -it --rm \
2828 -e OPENAI_API_KEY=your_key_here \
2929 -e WANDB_API_KEY=your_wandb_key \
30+ -v $( pwd) /data:/app/data \
31+ -v $( pwd) /configs:/app/configs \
32+ -v $( pwd) /results:/app/results \
3033 haerae-evaluation-toolkit:latest
3134
32- # Run with volume mounts
35+ # Run specific evaluation
3336docker run -it --rm \
37+ -e OPENAI_API_KEY=your_key_here \
3438 -v $( pwd) /data:/app/data \
3539 -v $( pwd) /configs:/app/configs \
36- -p 8000:8000 \
37- haerae-evaluation-toolkit:latest
40+ haerae-evaluation-toolkit:latest \
41+ python run_eval.py --config configs/your_config.yaml
42+
43+ # Interactive shell
44+ docker run -it --rm \
45+ -v $( pwd) :/workspace \
46+ haerae-evaluation-toolkit:latest \
47+ bash
3848```
3949
4050### 3. Using Docker Compose
4151
4252``` bash
43- # Start all services
44- docker-compose up -d
53+ # Start container (interactive mode)
54+ docker-compose up
4555
46- # View logs
47- docker-compose logs -f
56+ # Run in background and execute commands
57+ docker-compose up -d
58+ docker-compose exec hret python run_eval.py --help
4859
49- # Stop services
60+ # Stop container
5061docker-compose down
5162```
5263
@@ -88,6 +99,9 @@ The container supports the following environment variables:
8899| ----------| -------------| ---------|
89100| ` OPENAI_API_KEY ` | OpenAI API key | - |
90101| ` ANTHROPIC_API_KEY ` | Anthropic API key | - |
102+ | ` COHERE_API_KEY ` | Cohere API key | - |
103+ | ` MISTRAL_API_KEY ` | Mistral API key | - |
104+ | ` GOOGLE_API_KEY ` | Google API key | - |
91105| ` WANDB_API_KEY ` | Weights & Biases API key | - |
92106| ` HRET_HOME ` | Application home directory | ` /app ` |
93107| ` PYTHONPATH ` | Python path | ` /app ` |
@@ -96,20 +110,18 @@ The container supports the following environment variables:
96110
97111Recommended volume mounts:
98112
99- - ` /app/data ` - For datasets and evaluation results
113+ - ` /app/data ` - For datasets and input data
100114- ` /app/logs ` - For application logs
101115- ` /app/configs ` - For configuration files
102-
103- ## Ports
104-
105- - ` 8000 ` - FastAPI web server (if running web interface)
116+ - ` /app/results ` - For evaluation results and outputs
106117
107118## Docker Compose Configuration
108119
109120The ` docker-compose.yml ` includes:
110121
111- - ** hret** : Main application container
112- - ** redis** : Optional Redis cache (commented out by default)
122+ - ** hret** : Main application container with interactive mode
123+ - ** Volume Mounts** : For persistent data and configuration
124+ - ** Environment Variables** : For API keys and configuration
113125
114126### Environment File
115127
0 commit comments