IdeaboxAI-Vertical-ML-Service

Setup Instruction

1. Clone the repository

git clone git@github.com:ideaboxai/ideaboxai-vertical-ml-service.git
cd ideaboxai-vertical-ml-service

2. Set up Python Environment with uv

# Install uv (if not installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install dependencies from pyproject.toml
uv sync

# Install with development tools
uv sync --group dev

3. Configure dvc (for data & model versioning) If you installed dev dependencies, enable auto-staging for tracked files:

dvc config core.autostage true

Pull the latest data and model files:

dvc pull

4. Setup Pre-commit Hooks

pre-commit install

5. Running FastAPI app

python app.py

📦 Dependency Management

We use uv for fast, reproducible installs.

• Prod only: uv sync
• Dev environment: uv sync --group dev
• Add new dependency: uv add package_name
• Add new dev dependency: uv add --group dev package_name

📊 Data Version Control (DVC)

• Track a file:

dvc add data/raw/data.csv

• Commit changes:

git add data/.gitignore data/raw/data.csv.dvc
git commit -m "Add raw data"

• Push to remote storage:

dvc push