README-docker-compose.md

Fashion Analyzer - Docker Compose Setup

This project provides a secure, containerized fashion analysis application using Hugging Face Transformers and FastAPI with Docker Compose.

🏗️ Architecture

The application consists of a single service:

1. FastAPI Service: Provides the web API and user interface with integrated Hugging Face transformers models for fashion analysis

🔒 Security Features

• ✅ Pinned Python version (3.11-slim) - Secure base image
• ✅ Non-root user execution - Enhanced container security
• ✅ Security updates - Latest package updates applied
• ✅ Health checks - Service monitoring and restart policies
• ✅ Minimal dependencies - Reduced attack surface

🚀 Quick Start

Prerequisites

• Docker Engine 20.10+
• Docker Compose 2.0+

1. Start the Application

# Start all services
docker-compose up -d

# View logs
docker-compose logs -f

# Check service status
docker-compose ps

2. Access the Application

• Web Interface: http://localhost:7860
• API Documentation: http://localhost:7860/docs
• Health Check: http://localhost:7860/health

3. Stop the Application

# Stop all services
docker-compose down

# Stop and remove volumes (removes logs)
docker-compose down -v

📁 Project Structure

AI/
├── docker-compose.yml      # Main orchestration file
├── Dockerfile.fastapi      # FastAPI service Dockerfile
├── .env                    # Environment variables
├── .dockerignore          # Docker build exclusions
├── fast.py                # FastAPI application
├── requirements.txt       # Python dependencies
└── logs/                  # Application logs (created at runtime)

⚙️ Configuration

Environment Variables (.env)

FASTAPI_PORT=7860
ENVIRONMENT=development
LOG_LEVEL=info

Custom Configuration

To modify ports or other settings:

1. Edit .env file
2. Restart services: docker-compose up -d

🔧 Development

Building Images

# Build only FastAPI service
docker-compose build fastapi

# Build with no cache
docker-compose build --no-cache

Viewing Logs

# All services
docker-compose logs -f

# Specific service
docker-compose logs -f fastapi

Debugging

# Execute commands in running containers
docker-compose exec fastapi bash

# Check service health
docker-compose exec fastapi curl http://localhost:7860/health

📊 Monitoring

Health Checks

The FastAPI service includes health checks:

• FastAPI: Checks application health and model availability

🛠️ Troubleshooting

Common Issues

1. Port conflicts: Change ports in .env file
2. Model loading fails: Check internet connection and available memory
3. Application startup slow: Transformers models need time to download and load

Reset Everything

# Stop and remove everything
docker-compose down -v --remove-orphans

# Remove images
docker-compose down --rmi all

# Start fresh
docker-compose up -d

📈 Scaling

To run multiple FastAPI instances:

# Scale FastAPI service
docker-compose up -d --scale fastapi=3

Note: You'll need a load balancer for multiple instances.

🔐 Security Considerations

• Services run as non-root users
• Network isolation between services
• No sensitive data in environment variables
• Regular security updates applied
• Pinned dependency versions

📝 API Usage

Upload and Analyze Image

curl -X POST "http://localhost:7860/analyze-image" \
     -H "accept: application/json" \
     -H "Content-Type: multipart/form-data" \
     -F "[email protected]"

Health Check

curl http://localhost:7860/health

🤝 Contributing

1. Make changes to the code
2. Test with docker-compose up --build
3. Submit pull request

📄 License

This project is licensed under the MIT License.