Skip to content

setup-guide.md

Latest commit

 

History

History
60 lines (45 loc) · 1.61 KB

setup-guide.md

File metadata and controls

60 lines (45 loc) · 1.61 KB

Development Setup Guide

This page is for contributors working on the repo itself rather than just running a single experiment.

Working areas

Area When you touch it
datasets/ ingestion, manifests, slide extraction, dataset utilities
models/ PyTorch models, training code, conversion code
scripts/ orchestration wrappers and pipeline helpers
benchmarks/ benchmark entry points and result handling
tools/ desktop runner, reporting, comparison, and analysis utilities
android/ mobile app, workers, TFLite inference, and UI

Python setup

python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -r requirements.txt

Optional packages by workflow:

  • python -m pip install -r requirements-optional.txt
  • system ffmpeg for video extraction workflows
  • system Tesseract OCR if you use OCR evaluation

Android setup

cd android
.\gradlew tasks
.\gradlew assembleDebug

Open android/ in Android Studio if you need:

  • SDK setup
  • emulator/device debugging
  • Compose previews
  • logcat inspection

Helpful first commands

pytest tests/unit -q
python -m models.training.finetune_education --help
python -m models.training.evaluation --help
python tools/benchmark-runner/runner.py --help

Development tips

  • Validate manifests before long training runs.
  • Keep benchmark outputs out of source folders unless they are intentionally checked in.
  • When changing Android processing behavior, review the docs in docs/architecture/ and docs/api/ as part of the same pass.