Update README.md

README.md

@@ -10,13 +10,40 @@ license: other
 
 # VLAC2 Benchmark Release
 
-This release contains:
+VLAC2 is a video-progress benchmark for long-horizon robot manipulation. This release provides benchmark JSON files with dense ground-truth progress targets, the associated raw-data archives, and a minimal frame-extraction workflow for reproducible evaluation.
 
-- `benchmark_json/`: ready-to-use benchmark JSON files for `train/` and the 4 test buckets
-- `scripts/`: frame extraction utilities
-- `vlac2_release_data/`: raw-data archives plus their manifest
-- `docs/`: minimal usage notes
+## Contents
 
-The release repo itself does not ship `_extracted_frames/`; the frame-extraction script creates that default output directory automatically when needed.
-Before frame extraction, first unpack all raw-data archives into `vlac2_release_data/`.
-See `docs/vlac2_public_release.md` for the end-to-end workflow.
+- `benchmark_json/train/video_progress_benchmark_file.json`
+- `benchmark_json/test_expert_seen/video_progress_benchmark_file.json`
+- `benchmark_json/test_expert_unseen/video_progress_benchmark_file.json`
+- `benchmark_json/test_nonexpert_seen/video_progress_benchmark_file.json`
+- `benchmark_json/test_nonexpert_unseen/video_progress_benchmark_file.json`
+- `scripts/extract_vlac2_release_raw_archives.sh`
+- `scripts/extract_vlac2_release_frames.py`
+- `scripts/vlac2_release_common.py`
+- `vlac2_release_data/vlac2_release_data_part*.tar.zst`
+
+## Usage
+
+1. Unpack all raw-data archives into `vlac2_release_data/`.
+
+```bash
+bash scripts/extract_vlac2_release_raw_archives.sh /path/to/vlac2_release/vlac2_release_data
+```
+
+2. Extract benchmark frames from the raw videos.
+
+```bash
+python scripts/extract_vlac2_release_frames.py --release-root /path/to/vlac2_release
+```
+
+If `--output-root` is not specified, extracted frames are written to `/path/to/vlac2_release/_extracted_frames/`, which is created automatically by the script.
+
+3. Use the benchmark JSON files for training or evaluation. Frame paths in the JSONs use the placeholder prefix `__VLAC2_RELEASE_ROOT__`, which should be replaced with the absolute path of the local release root.
+
+## Notes
+
+- The benchmark JSON files are ready to use; users do not need to rebuild them.
+- A video decoder backend is required for frame extraction: `opencv-python` or `imageio`.
+- The raw-video distribution and the extracted-frame cache are intentionally separated so that users can regenerate frames locally under their own storage layout.