diff --git a/model/README.md b/model/README.md new file mode 100644 index 0000000..5db9c82 --- /dev/null +++ b/model/README.md @@ -0,0 +1,31 @@ +# model + +Python + PyTorch perimeter. This is the only directory in the project that uses Python. + +## Contents + +``` +model/ + train.py TS-JEPA training entry point + configs/ YAML configs per phase + phase0-mae.yaml + phase1-tsjepa.yaml + tsjepa/ TS-JEPA model implementation (adapted from paper) + tests/ pytest tests for model components + requirements.txt pinned Python dependencies + .venv/ (gitignored — created by `task model:setup`) +``` + +## Setup + +```bash +task model:setup # creates .venv and installs requirements via uv +``` + +## Dependency policy + +Every Python dependency must be justified in a comment in `requirements.txt`. Prefer Go implementations for anything outside the training loop. When adding a new dependency, add an entry to DECISIONS.md explaining why a Go alternative wasn't sufficient. + +## Python version + +3.12 (pinned in `.python-version`)