chore: Migrate from Poetry to UV, added health checkpoint, and improved dockerimage #15
+2,641
−3,702
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # Version control | ||
| .git | ||
| .gitignore | ||
| .gitattributes | ||
|
|
||
| # Python | ||
| __pycache__/ | ||
| *.py[cod] | ||
| *$py.class | ||
| *.so | ||
| .Python | ||
| .env | ||
| .venv/ | ||
| venv/ | ||
| ENV/ | ||
| env/ | ||
| .pytest_cache/ | ||
| .coverage | ||
| htmlcov/ | ||
| .tox/ | ||
| .nox/ | ||
| .hypothesis/ | ||
| .mypy_cache/ | ||
|
|
||
| # IDE | ||
| .idea/ | ||
| .vscode/ | ||
| *.swp | ||
| *.swo | ||
| .DS_Store | ||
|
|
||
| # Project specific | ||
| tests/ | ||
| docs/ | ||
| *.md | ||
| !README.md | ||
| Makefile | ||
| docker-compose*.yml | ||
| .dockerignore | ||
| Dockerfile* | ||
|
|
||
| # Cache and temp files | ||
| *.log | ||
| .cache/ | ||
| tmp/ | ||
| temp/ | ||
|
|
||
| # Distribution / packaging | ||
| dist/ | ||
| build/ | ||
| *.egg-info/ | ||
|
|
||
| # Local development | ||
| *.local | ||
| .env.local | ||
| .env.*.local | ||
|
|
||
| # Model cache and downloads | ||
| model_cache/ | ||
| downloads/ | ||
|
|
||
| *.pyc | ||
| *.pyo | ||
| *.pyd | ||
| .env |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -18,3 +18,4 @@ | ||
| .idea/misc.xml | ||
| .env | ||
| .DS_Store | ||
| __pycache__/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,98 @@ | ||
| FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS builder | ||
| ARG CPU_ONLY=false | ||
|
|
||
| WORKDIR /app | ||
|
|
||
| # Install build dependencies | ||
| RUN apt-get update && \ | ||
| apt-get install -y --no-install-recommends libgl1 libglib2.0-0 && \ | ||
| rm -rf /var/lib/apt/lists/* | ||
|
|
||
| # Enable bytecode compilation and set proper link mode for cache mounting | ||
| ENV UV_COMPILE_BYTECODE=1 \ | ||
| UV_LINK_MODE=copy \ | ||
| HF_HOME=/app/.cache/huggingface \ | ||
| TORCH_HOME=/app/.cache/torch \ | ||
| PYTHONPATH=/app \ | ||
| OMP_NUM_THREADS=4 | ||
|
|
||
| # Copy dependency files and README | ||
| COPY pyproject.toml uv.lock README.md ./ | ||
|
|
||
| # Install dependencies but not the project itself | ||
| RUN --mount=type=cache,target=/root/.cache/uv \ | ||
| uv sync --frozen --no-install-project | ||
|
|
||
| # Copy the rest of the project | ||
| COPY . . | ||
|
|
||
| # Better GPU detection: Check both architecture and if NVIDIA is available | ||
| RUN ARCH=$(uname -m) && \ | ||
| if [ "$CPU_ONLY" = "true" ] || [ "$ARCH" = "aarch64" ] || [ "$ARCH" = "arm64" ] || ! command -v nvidia-smi >/dev/null 2>&1; then \ | ||
| USE_GPU=false; \ | ||
| else \ | ||
| USE_GPU=true; \ | ||
| fi && \ | ||
| echo "Detected GPU availability: $USE_GPU" && \ | ||
| # For PyTorch installation with architecture detection | ||
| uv pip uninstall -y torch torchvision torchaudio || true && \ | ||
| if [ "$USE_GPU" = "false" ]; then \ | ||
| # For CPU or ARM architectures or no NVIDIA | ||
| echo "Installing PyTorch for CPU" && \ | ||
| uv pip install --no-cache-dir torch torchvision --extra-index-url https://download.pytorch.org/whl/cpu; \ | ||
| else \ | ||
| # For x86_64 with GPU support | ||
| echo "Installing PyTorch with CUDA support" && \ | ||
| uv pip install --no-cache-dir torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu121; \ | ||
| fi | ||
|
|
||
| # Install the project in non-editable mode | ||
| RUN --mount=type=cache,target=/root/.cache/uv \ | ||
| uv sync --frozen --no-editable | ||
|
|
||
| # Download models for the pipeline | ||
| RUN uv run python -c "from docling.pipeline.standard_pdf_pipeline import StandardPdfPipeline; artifacts_path = StandardPdfPipeline.download_models_hf(force=True)" | ||
|
|
||
| # Pre-download EasyOCR models with better GPU detection | ||
| RUN ARCH=$(uname -m) && \ | ||
| if [ "$CPU_ONLY" = "true" ] || [ "$ARCH" = "aarch64" ] || [ "$ARCH" = "arm64" ] || ! command -v nvidia-smi >/dev/null 2>&1; then \ | ||
| echo "Downloading EasyOCR models for CPU" && \ | ||
| uv run python -c "import easyocr; reader = easyocr.Reader(['fr', 'de', 'es', 'en', 'it', 'pt'], gpu=False); print('EasyOCR CPU models downloaded successfully')"; \ | ||
| else \ | ||
| echo "Downloading EasyOCR models with GPU support" && \ | ||
| uv run python -c "import easyocr; reader = easyocr.Reader(['fr', 'de', 'es', 'en', 'it', 'pt'], gpu=True); print('EasyOCR GPU models downloaded successfully')"; \ | ||
| fi | ||
|
|
||
| # Production stage | ||
| FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim | ||
| WORKDIR /app | ||
|
|
||
| # Install runtime dependencies | ||
| RUN apt-get update && \ | ||
| apt-get install -y --no-install-recommends redis-server libgl1 libglib2.0-0 curl && \ | ||
| rm -rf /var/lib/apt/lists/* | ||
|
|
||
| # Set environment variables | ||
| ENV HF_HOME=/app/.cache/huggingface \ | ||
| TORCH_HOME=/app/.cache/torch \ | ||
| PYTHONPATH=/app \ | ||
| OMP_NUM_THREADS=4 \ | ||
| UV_COMPILE_BYTECODE=1 | ||
|
|
||
| # Create a non-root user | ||
| RUN useradd --create-home app && \ | ||
| mkdir -p /app && \ | ||
| chown -R app:app /app /tmp | ||
|
|
||
| # Copy the virtual environment from the builder stage | ||
| COPY --from=builder --chown=app:app /app/.venv /app/.venv | ||
| ENV PATH="/app/.venv/bin:$PATH" | ||
|
|
||
| # Copy necessary files for the application | ||
| COPY --chown=app:app . . | ||
|
|
||
| # Switch to non-root user | ||
| USER app | ||
|
|
||
| EXPOSE 8080 | ||
| CMD ["uvicorn", "main:app", "--port", "8080", "--host", "0.0.0.0"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| # Variables | ||
| PYTHON = poetry run | ||
| DOCKER_CPU_COMPOSE = docker-compose -f docker-compose.cpu.yml | ||
| DOCKER_GPU_COMPOSE = docker-compose -f docker-compose.gpu.yml | ||
| DOCKER_IMAGE = docling-api | ||
| PORT = 8080 | ||
| WORKERS = 4 | ||
|
|
||
| .PHONY: help install dev-setup start stop clean docker-* test lint format | ||
|
|
||
| help: | ||
| @echo "Available commands:" | ||
| @echo "Development:" | ||
| @echo " install - Install project dependencies using Poetry" | ||
| @echo " dev-setup - Setup development environment (install Redis, etc.)" | ||
| @echo " start - Start all development services locally" | ||
| @echo " stop - Stop all development services" | ||
| @echo " clean - Clean up temporary files and caches" | ||
| @echo "" | ||
| @echo "Docker:" | ||
| @echo " docker-build-cpu - Build Docker image (CPU version)" | ||
| @echo " docker-build-gpu - Build Docker image (GPU version)" | ||
| @echo " docker-start - Auto-detect system and start appropriate container (CPU/GPU)" | ||
| @echo " docker-start-cpu - Start services in CPU mode" | ||
| @echo " docker-start-gpu - Start services in GPU mode" | ||
| @echo " docker-stop - Stop all Docker services" | ||
| @echo " docker-clean - Clean Docker resources" | ||
| @echo "" | ||
| @echo "Code Quality:" | ||
| @echo " format - Format code using black" | ||
| @echo " lint - Run linter" | ||
| @echo " test - Run tests" | ||
|
|
||
| # Development commands | ||
| install: | ||
| curl -sSL https://install.python-poetry.org | python3 - | ||
| poetry install | ||
|
|
||
| dev-setup: | ||
| @echo "Setting up development environment..." | ||
| @if [ "$(shell uname)" = "Darwin" ]; then \ | ||
| brew install redis; \ | ||
| brew services start redis; \ | ||
| elif [ -f /etc/debian_version ]; then \ | ||
| sudo apt-get update && sudo apt-get install -y redis-server; \ | ||
| sudo service redis-server start; \ | ||
| fi | ||
| @echo "Creating .env file..." | ||
| @echo "REDIS_HOST=redis://localhost:6379/0" > .env | ||
| @echo "ENV=development" >> .env | ||
|
|
||
| start: | ||
| @echo "Starting FastAPI server..." | ||
| $(PYTHON) uvicorn main:app --reload --port $(PORT) & \ | ||
| echo "Starting Celery worker..." && \ | ||
| $(PYTHON) celery -A worker.celery_config worker --pool=solo -n worker_primary --loglevel=info & \ | ||
| echo "Starting Flower dashboard..." && \ | ||
| $(PYTHON) celery -A worker.celery_config flower --port=5555 | ||
|
|
||
| stop: | ||
| @echo "Stopping services..." | ||
| @pkill -f "uvicorn main:app" || true | ||
| @pkill -f "celery" || true | ||
| @if [ "$(shell uname)" = "Darwin" ]; then \ | ||
| brew services stop redis; \ | ||
| elif [ -f /etc/debian_version ]; then \ | ||
| sudo service redis-server stop; \ | ||
| fi | ||
|
|
||
| # Docker commands | ||
| docker-build-cpu: | ||
| docker build --build-arg CPU_ONLY=true -t $(DOCKER_IMAGE):cpu . | ||
|
|
||
| docker-build-gpu: | ||
| docker build -t $(DOCKER_IMAGE):gpu . | ||
|
|
||
| docker-start-cpu: | ||
| $(DOCKER_CPU_COMPOSE) up --build --scale celery_worker=1 | ||
|
|
||
| docker-start-gpu: | ||
| $(DOCKER_GPU_COMPOSE) up --build --scale celery_worker=3 | ||
|
|
||
| # Auto-detect architecture and start appropriate container | ||
| docker-start: | ||
| @echo "Auto-detecting system architecture..." | ||
| @if [ "$(shell uname -m)" = "arm64" ] || [ "$(shell uname -m)" = "aarch64" ] || ! command -v nvidia-smi >/dev/null 2>&1; then \ | ||
| echo "ARM architecture or NVIDIA drivers not detected. Using CPU mode."; \ | ||
| $(MAKE) docker-start-cpu; \ | ||
| else \ | ||
| echo "NVIDIA GPU detected. Using GPU mode."; \ | ||
| $(MAKE) docker-start-gpu; \ | ||
| fi | ||
|
|
||
| docker-stop: | ||
| $(DOCKER_CPU_COMPOSE) down | ||
| $(DOCKER_GPU_COMPOSE) down | ||
|
|
||
| docker-clean: | ||
| docker system prune -f | ||
| docker volume prune -f | ||
|
|
||
| # Code quality commands | ||
| format: | ||
| $(PYTHON) black . | ||
|
|
||
| lint: | ||
| $(PYTHON) flake8 . | ||
| $(PYTHON) mypy . | ||
|
|
||
| test: | ||
| $(PYTHON) pytest | ||
|
|
||
| clean: | ||
| find . -type d -name "__pycache__" -exec rm -rf {} + | ||
| find . -type f -name "*.pyc" -delete | ||
| find . -type f -name "*.pyo" -delete | ||
| find . -type f -name "*.pyd" -delete | ||
| find . -type f -name ".coverage" -delete | ||
| find . -type d -name "*.egg-info" -exec rm -rf {} + | ||
| find . -type d -name "*.egg" -exec rm -rf {} + | ||
| find . -type d -name ".pytest_cache" -exec rm -rf {} + | ||
| find . -type d -name ".mypy_cache" -exec rm -rf {} + | ||
| find . -type d -name ".tox" -exec rm -rf {} + | ||
| find . -type d -name "build" -exec rm -rf {} + | ||
| find . -type d -name "dist" -exec rm -rf {} + |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Script to detect GPU and select the appropriate Docker Compose file | ||
|
|
||
| # Check if nvidia-smi exists and can be executed | ||
| if command -v nvidia-smi >/dev/null 2>&1; then | ||
| # Try to run nvidia-smi to check if drivers are loaded correctly | ||
| if nvidia-smi >/dev/null 2>&1; then | ||
| echo "NVIDIA GPU detected with working drivers." | ||
| GPU_AVAILABLE=true | ||
|
|
||
| # Check CUDA version | ||
| CUDA_VERSION=$(nvidia-smi --query-gpu=driver_version --format=csv,noheader | cut -d'.' -f1) | ||
| echo "CUDA compatible driver version: $CUDA_VERSION" | ||
|
|
||
| # Check if the detected CUDA version is compatible with our requirements (CUDA 11+) | ||
| if [ -n "$CUDA_VERSION" ] && [ "$CUDA_VERSION" -ge 11 ]; then | ||
| echo "Using GPU configuration (CUDA $CUDA_VERSION detected)" | ||
| COMPOSE_FILE="docker-compose.gpu.yml" | ||
| DOCKER_BUILDKIT=1 | ||
| DOCKER_BUILD_ARGS="--build-arg CPU_ONLY=false" | ||
| # Pass GPU capabilities to docker build | ||
| export DOCKER_BUILDKIT=1 | ||
| export DOCKER_DEFAULT_PLATFORM=linux/amd64 | ||
| export DOCKER_CLI_EXPERIMENTAL=enabled | ||
| else | ||
| echo "NVIDIA GPU detected but CUDA version ($CUDA_VERSION) is too old. Minimum required: 11" | ||
| echo "Falling back to CPU configuration." | ||
| GPU_AVAILABLE=false | ||
| COMPOSE_FILE="docker-compose.cpu.yml" | ||
| DOCKER_BUILD_ARGS="--build-arg CPU_ONLY=true" | ||
| fi | ||
| else | ||
| echo "NVIDIA GPU software detected but drivers may not be properly installed." | ||
| GPU_AVAILABLE=false | ||
| COMPOSE_FILE="docker-compose.cpu.yml" | ||
| DOCKER_BUILD_ARGS="--build-arg CPU_ONLY=true" | ||
| fi | ||
| else | ||
| echo "No NVIDIA GPU detected. Using CPU configuration." | ||
| GPU_AVAILABLE=false | ||
| COMPOSE_FILE="docker-compose.cpu.yml" | ||
| DOCKER_BUILD_ARGS="--build-arg CPU_ONLY=true" | ||
| fi | ||
|
|
||
| # Check architecture | ||
| ARCH=$(uname -m) | ||
| if [ "$ARCH" = "aarch64" ] || [ "$ARCH" = "arm64" ]; then | ||
| echo "ARM architecture detected. Forcing CPU mode regardless of GPU availability." | ||
| GPU_AVAILABLE=false | ||
| COMPOSE_FILE="docker-compose.cpu.yml" | ||
| DOCKER_BUILD_ARGS="--build-arg CPU_ONLY=true" | ||
| fi | ||
|
|
||
| # Export for other scripts to use | ||
| export GPU_AVAILABLE | ||
| export COMPOSE_FILE | ||
| export DOCKER_BUILD_ARGS | ||
|
|
||
| echo "Selected configuration: $COMPOSE_FILE" | ||
| echo "Build arguments: $DOCKER_BUILD_ARGS" | ||
| echo "GPU_AVAILABLE=$GPU_AVAILABLE" | ||
|
|
||
| # If this script is being sourced, don't execute docker-compose | ||
| if [[ "${BASH_SOURCE[0]}" != "${0}" ]]; then | ||
| return 0 | ||
| fi | ||
|
|
||
| # If passed arguments, run docker-compose with them | ||
| if [ $# -gt 0 ]; then | ||
| echo "Running: docker-compose -f $COMPOSE_FILE $@" | ||
| docker-compose -f $COMPOSE_FILE $@ | ||
| else | ||
| echo "Usage: $0 [docker-compose commands]" | ||
| echo "or source this script to export the variables" | ||
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| #!/bin/sh | ||
| set -e | ||
|
|
||
|
|
||
| echo "Starting application..." | ||
| exec /app/.venv/bin/python -m uvicorn --port 8080 --host 0.0.0.0 main:app |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,26 @@ | ||
| [project] | ||
| name = "document-to-markdown" | ||
| version = "0.1.0" | ||
| description = "" | ||
| authors = [ | ||
| {name = "davidemmanuel75@gmail.com", email = "davidemmanuel75@gmail.com"}, | ||
| ] | ||
| readme = "README.md" | ||
| requires-python = ">=3.12" | ||
| dependencies = [ | ||
| "fastapi>=0.115.4", | ||
| "uvicorn>=0.32.0", | ||
| "docling>=2.25.1", | ||
| "python-multipart>=0.0.17", | ||
| "celery>=5.4.0", | ||
| "flower>=2.0.1", | ||
| "redis>=5.2.0", | ||
| "gunicorn>=23.0.0", | ||
| ] | ||
|
|
||
| [build-system] | ||
| requires = ["hatchling"] | ||
| build-backend = "hatchling.build" | ||
|
|
||
| [tool.hatch.build.targets.wheel] | ||
| packages = ["."] |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we also add instructions on how to install uv for those using windows or add a link to the uv installation doc? @spa5k