VibecoderMcSwaggins's picture
feat(phase-5): polish, observability, and documentation (#6)
bfe80c5 unverified
# Quickstart
Get started with stroke-deepisles-demo in 5 minutes.
## Prerequisites
- Python 3.11+
- Docker (for DeepISLES inference)
- ~10GB disk space (for Docker image and datasets)
## Installation
```bash
# Clone
git clone https://github.com/The-Obstacle-Is-The-Way/stroke-deepisles-demo.git
cd stroke-deepisles-demo
# Install
uv sync
```
## Pull DeepISLES Docker Image
```bash
docker pull isleschallenge/deepisles
```
## Run Locally
### Option 1: Gradio UI
```bash
uv run python -m stroke_deepisles_demo.ui.app
# Open http://localhost:7860
```
### Option 2: CLI
```bash
# List available cases
uv run stroke-demo list
# Run on a specific case
uv run stroke-demo run --case sub-stroke0001 --fast
```
### Option 3: Python API
```python
from stroke_deepisles_demo.pipeline import run_pipeline_on_case
result = run_pipeline_on_case("sub-stroke0001", fast=True)
print(f"Dice score: {result.dice_score:.3f}")
print(f"Prediction: {result.prediction_mask}")
```
## Configuration
Set environment variables or create a `.env` file:
```bash
# .env
STROKE_DEMO_LOG_LEVEL=DEBUG
STROKE_DEMO_DEEPISLES_USE_GPU=false # If no GPU available
```
See [Configuration Guide](configuration.md) for all options.