Finalize simplified release interface for README.md
Browse files
README.md
CHANGED
|
@@ -21,37 +21,45 @@ VLAC2 is a video-progress benchmark for long-horizon robot manipulation. This re
|
|
| 21 |
- `benchmark_splits/test_nonexpert_unseen/video_progress_benchmark_file.json`
|
| 22 |
- `scripts/extract_vlac2_release_raw_archives.sh`
|
| 23 |
- `scripts/extract_vlac2_release_frames.py`
|
| 24 |
-
- `scripts/vlac2_release_common.py`
|
| 25 |
- `data/train_videos.tar`
|
| 26 |
- `data/test_videos.tar`
|
| 27 |
|
| 28 |
## Usage
|
| 29 |
|
| 30 |
-
1. Unpack the
|
| 31 |
|
| 32 |
```bash
|
| 33 |
-
bash scripts/extract_vlac2_release_raw_archives.sh
|
| 34 |
-
/path/to/vlac2_release/data \
|
| 35 |
-
/path/to/vlac2_release/data
|
| 36 |
```
|
| 37 |
|
| 38 |
-
|
| 39 |
-
|
| 40 |
|
| 41 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 42 |
|
| 43 |
```bash
|
| 44 |
-
python scripts/extract_vlac2_release_frames.py --
|
| 45 |
```
|
| 46 |
|
| 47 |
-
|
| 48 |
-
If `--output-root` is not specified, extracted frames are written to `/path/to/vlac2_release/_extracted_frames/`, which is created automatically by the script.
|
| 49 |
|
| 50 |
-
|
|
|
|
| 51 |
|
| 52 |
## Notes
|
| 53 |
|
| 54 |
-
- The benchmark JSON files are ready to use; users do not need to rebuild them.
|
| 55 |
- A video decoder backend is required for frame extraction: `opencv-python` or `imageio`.
|
| 56 |
- This repo only contains the raw videos required by the released benchmark splits. The full raw-data release is distributed separately.
|
| 57 |
-
- The
|
|
|
|
| 21 |
- `benchmark_splits/test_nonexpert_unseen/video_progress_benchmark_file.json`
|
| 22 |
- `scripts/extract_vlac2_release_raw_archives.sh`
|
| 23 |
- `scripts/extract_vlac2_release_frames.py`
|
|
|
|
| 24 |
- `data/train_videos.tar`
|
| 25 |
- `data/test_videos.tar`
|
| 26 |
|
| 27 |
## Usage
|
| 28 |
|
| 29 |
+
1. Unpack the video archives.
|
| 30 |
|
| 31 |
```bash
|
| 32 |
+
bash scripts/extract_vlac2_release_raw_archives.sh
|
|
|
|
|
|
|
| 33 |
```
|
| 34 |
|
| 35 |
+
This extracts `data/test_videos.tar` and `data/train_videos.tar` into `data/`.
|
| 36 |
+
To extract the raw videos elsewhere, pass a target directory:
|
| 37 |
|
| 38 |
+
```bash
|
| 39 |
+
bash scripts/extract_vlac2_release_raw_archives.sh /path/to/data
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
2. Extract frames.
|
| 43 |
+
|
| 44 |
+
```bash
|
| 45 |
+
python scripts/extract_vlac2_release_frames.py --data-root data
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
This writes extracted frames to `_extracted_frames/` under the release directory.
|
| 49 |
+
Only the benchmark main view is extracted.
|
| 50 |
+
If the raw videos were extracted elsewhere:
|
| 51 |
|
| 52 |
```bash
|
| 53 |
+
python scripts/extract_vlac2_release_frames.py --data-root /path/to/data
|
| 54 |
```
|
| 55 |
|
| 56 |
+
3. Use the benchmark splits.
|
|
|
|
| 57 |
|
| 58 |
+
Frame paths in the JSON files use the prefix `__VLAC2_FRAMES_ROOT__/...`.
|
| 59 |
+
Replace `__VLAC2_FRAMES_ROOT__` with the absolute path of `_extracted_frames`.
|
| 60 |
|
| 61 |
## Notes
|
| 62 |
|
|
|
|
| 63 |
- A video decoder backend is required for frame extraction: `opencv-python` or `imageio`.
|
| 64 |
- This repo only contains the raw videos required by the released benchmark splits. The full raw-data release is distributed separately.
|
| 65 |
+
- The benchmark JSON files are ready to use. No benchmark reconstruction is required.
|