File size: 8,389 Bytes
54c5666 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | # Docker Usage Guide
Complete guide for using ULTRATHINK with Docker.
## π Quick Start
### Run Web Interface (Default)
```bash
docker compose up app
# Visit http://localhost:7860
```
### Run Training (CPU)
```bash
docker compose --profile train up
```
### Run Training (GPU)
```bash
docker compose --profile train-gpu up
```
## π¦ Available Services
### 1. Web Interface (`app`)
**Purpose**: Interactive Gradio UI for model inference
```bash
# Start the web interface
docker compose up app
# Run in background
docker compose up -d app
# View logs
docker compose logs -f app
```
**Ports**:
- 7860: Gradio web interface
- 8000: FastAPI (if needed)
**Volumes**:
- `./outputs` - Model outputs
- `./checkpoints` - Model checkpoints
---
### 2. CPU Training (`train`)
**Purpose**: Train models on CPU (for testing/small models)
```bash
# Start training with default config
docker compose --profile train up
# Custom training command
docker compose run --rm train python train_ultrathink.py \
--dataset wikitext \
--hidden_size 512 \
--num_layers 6 \
--batch_size 2 \
--num_epochs 3
```
**Example - WikiText Training**:
```bash
docker compose run --rm train python train_advanced.py \
--config /app/configs/train_small.yaml
```
---
### 3. GPU Training (`train-gpu`)
**Purpose**: Train models with GPU acceleration
**Prerequisites**:
- NVIDIA GPU
- NVIDIA Docker runtime
- nvidia-container-toolkit
```bash
# Start GPU training
docker compose --profile train-gpu up
# Custom GPU training
docker compose run --rm train-gpu python train_ultrathink.py \
--dataset c4 --streaming \
--hidden_size 768 --num_layers 12 \
--use_amp --gradient_checkpointing \
--output_dir /app/outputs/c4_model
```
---
### 4. MLflow Tracking (`mlflow`)
**Purpose**: Experiment tracking and model registry
```bash
# Start MLflow server
docker compose --profile mlflow up -d
# Access UI
# http://localhost:5000
```
**Train with MLflow tracking**:
```bash
docker compose run --rm \
--env MLFLOW_TRACKING_URI=http://mlflow:5000 \
train python train_ultrathink.py \
--use_mlflow \
--dataset wikitext \
--num_epochs 3
```
---
### 5. Development Environment (`dev`)
**Purpose**: Interactive development with all tools
```bash
# Start dev container
docker compose --profile dev run --rm dev
# Inside container:
pytest # Run tests
python train_ultrathink.py --help
jupyter notebook --ip 0.0.0.0 --port 8888
```
**Access Jupyter**:
- http://localhost:8888
---
## π― Common Use Cases
### Use Case 1: Quick Demo
```bash
# Start web interface only
docker compose up app
# Visit http://localhost:7860
```
### Use Case 2: Training + Monitoring
```bash
# Start MLflow and training
docker compose --profile mlflow up -d
docker compose --profile train up
```
### Use Case 3: Full Development Stack
```bash
# Start all services
docker compose --profile dev --profile mlflow up
```
### Use Case 4: Production Training
```bash
# GPU training with checkpointing
docker compose run --rm train-gpu \
python train_advanced.py \
--config /app/configs/train_medium.yaml \
--checkpoint_frequency 1000 \
--output_dir /app/outputs/production_model
```
---
## π§ Advanced Usage
### Building Specific Stages
**Production image (minimal)**:
```bash
docker build --target production -t ultrathink:prod .
```
**Development image (with tools)**:
```bash
docker build --target development -t ultrathink:dev .
```
**Training image**:
```bash
docker build --target training -t ultrathink:train .
```
### Custom Environment Variables
Create `.env` file:
```env
WANDB_API_KEY=your_api_key_here
HF_TOKEN=your_hf_token_here
MLFLOW_TRACKING_URI=http://mlflow:5000
PYTORCH_CUDA_ALLOC_CONF=expandable_segments:True
```
Run with env file:
```bash
docker compose --env-file .env up
```
### Volume Mounting for Development
```bash
# Mount entire project (live editing)
docker run -it --rm \
-v $(pwd):/app \
ultrathink:dev bash
```
### Multi-GPU Training
```bash
# Use specific GPUs
docker compose run --rm \
--env CUDA_VISIBLE_DEVICES=0,1,2,3 \
train-gpu python train_ultrathink.py \
--distributed \
--num_gpus 4
```
---
## π Monitoring
### View Logs
```bash
# View all logs
docker compose logs
# Follow specific service
docker compose logs -f app
# Last 100 lines
docker compose logs --tail 100 train
```
### Check Resource Usage
```bash
# Container stats
docker stats
# Specific container
docker stats ultrathink_train_gpu
```
### Access Running Container
```bash
# Execute command in running container
docker compose exec app bash
# Run pytest in running container
docker compose exec app pytest
```
---
## π§Ή Cleanup
### Stop Services
```bash
# Stop all services
docker compose down
# Stop and remove volumes
docker compose down -v
```
### Remove Images
```bash
# Remove project images
docker rmi ultrathink:latest ultrathink:training ultrathink:dev
# Prune unused images
docker image prune -a
```
### Clean Build Cache
```bash
docker builder prune -a
```
---
## π Troubleshooting
### Issue: GPU not detected
**Solution**:
```bash
# Check NVIDIA runtime
docker run --rm --gpus all nvidia/cuda:11.8.0-base-ubuntu22.04 nvidia-smi
# Install nvidia-container-toolkit if needed
# https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html
```
### Issue: Out of memory
**Solution**:
```bash
# Reduce batch size
docker compose run --rm train python train_ultrathink.py \
--batch_size 1 \
--gradient_accumulation_steps 32
# Use gradient checkpointing
docker compose run --rm train python train_ultrathink.py \
--gradient_checkpointing
```
### Issue: Slow training
**Solution**:
```bash
# Enable AMP and optimizations
docker compose run --rm train-gpu python train_ultrathink.py \
--use_amp \
--gradient_checkpointing \
--use_flash_attention
```
### Issue: Container fails to start
**Solution**:
```bash
# Check logs
docker compose logs app
# Rebuild image
docker compose build --no-cache app
# Check disk space
docker system df
```
---
## π Security Best Practices
1. **Don't hardcode secrets** - Use environment variables
2. **Use .env file** - Keep secrets out of docker-compose.yml
3. **Limit port exposure** - Only expose necessary ports
4. **Use specific tags** - Avoid `latest` in production
5. **Scan images** - Use `docker scan ultrathink:latest`
6. **Non-root user** - Run containers as non-root (future enhancement)
---
## π Additional Resources
- [Docker Documentation](https://docs.docker.com/)
- [Docker Compose Reference](https://docs.docker.com/compose/compose-file/)
- [NVIDIA Container Toolkit](https://github.com/NVIDIA/nvidia-docker)
- [Main README](README.md)
- [Training Guide](TRAINING_QUICKSTART.md)
---
## π Examples
### Example 1: Complete Training Pipeline
```bash
# 1. Start MLflow
docker compose --profile mlflow up -d
# 2. Train model
docker compose run --rm train python train_ultrathink.py \
--dataset wikitext \
--use_mlflow \
--num_epochs 5 \
--output_dir /app/outputs/wikitext_model
# 3. Check MLflow UI
# Visit http://localhost:5000
# 4. Start inference UI
docker compose up app
# 5. Cleanup
docker compose down
```
### Example 2: Distributed Training
```bash
# Multi-GPU training with DeepSpeed
docker compose run --rm \
--env CUDA_VISIBLE_DEVICES=0,1,2,3 \
train-gpu python train_ultrathink.py \
--distributed \
--deepspeed \
--deepspeed_config /app/configs/deepspeed_z3.json \
--dataset c4 --streaming
```
### Example 3: Development Workflow
```bash
# Start dev container
docker compose --profile dev run --rm dev bash
# Inside container:
# 1. Run tests
pytest
# 2. Train small model
python train_ultrathink.py --dataset wikitext --num_epochs 1
# 3. Profile performance
python scripts/profile_model.py --size tiny
# 4. Exit
exit
```
---
For more information, see the [main README](README.md) or [Advanced Training Guide](ADVANCED_TRAINING_GUIDE.md).
|