Skip to content

Commit eb09c7c

Browse files
committed
docs(contributing): document the manual GPU verification scripts
1 parent d4711b6 commit eb09c7c

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,22 @@ cd world_model_py && python3 -m pytest test/test_adapters.py test/test_jepa.py \
2424
```
2525

2626
CI mirrors this: a ROS-free `unit` job and a full ROS 2 Jazzy `colcon` job. Both
27-
must stay green. GPU-only checks (`test/gpu_verify_*.py`) are **not** in CI — run
28-
them locally if you touch the `ijepa` path.
27+
must stay green.
28+
29+
### Manual GPU checks (not in CI)
30+
31+
These download real weights and need a GPU, so they are kept out of CI. Run the
32+
relevant one if you touch the `ijepa` / `vjepa2` paths (source the workspace
33+
first):
34+
35+
```bash
36+
python3 world_model_py/test/gpu_verify_jepa.py # I-JEPA: image -> latent -> surprise
37+
python3 world_model_py/test/gpu_verify_vjepa2.py # V-JEPA 2: video clip -> surprise
38+
python3 world_model_py/test/gpu_verify_runtime_ijepa.py # real I-JEPA through the ROS 2 lifecycle node
39+
```
40+
41+
Each prints a per-frame surprise sequence and an `*_OK` line when surprise
42+
spikes on scene changes as expected.
2943

3044
## Design rules (please keep these intact)
3145

0 commit comments

Comments
 (0)