Model card: use hf: references and fetch_checkpoints.py

README.md

@@ -51,15 +51,17 @@ Each folder holds `model.safetensors`, `config.json`, `dataset_stats.json`, `tra
 
 ## Use
 
-```python
-from huggingface_hub import snapshot_download
-root = snapshot_download("rizgiak/physai-study-01-checkpoints", allow_patterns=["act_randomized_look_seed0/*"])
-checkpoint = root + "/act_randomized_look_seed0"
+With the physai framework (https://github.com/PhysAI-Robot/physai-robot-starter), `--checkpoint` takes a reference
+to a folder of this repository and downloads it into `checkpoints/` (ignored by git):
+
+```bash
+python scripts/eval_policy.py --manifest research/configs/so101_randomized_pick_place.yaml --policy lerobot --checkpoint hf:rizgiak/physai-study-01-checkpoints/act_randomized_look_seed0@<commit>
+python scripts/fetch_checkpoints.py hf:rizgiak/physai-study-01-checkpoints/act_randomized_look_seed0   # download only, to use offline
 ```
 
-then pass `checkpoint` as `--checkpoint` to `scripts/eval_policy.py` of the physai framework with the study's
-manifest (`research/configs/so101_randomized_pick_place.yaml`) and `--policy lerobot`. For the Diffusion Policy
-checkpoints add `--policy-arg n_action_steps=16`.
+Name a commit (`@<commit>`) for a result you report; without one `main` is used. For the Diffusion Policy
+checkpoints add `--policy-arg n_action_steps=16`. To use a folder without the framework's downloader, fetch it with
+`huggingface_hub.snapshot_download("rizgiak/physai-study-01-checkpoints", allow_patterns=["<folder>/*"])` and pass its path to `--checkpoint`.
 
 Three kinds of seeds appear and they are unrelated: