futurefantasy commited on
Commit
4916875
·
verified ·
1 Parent(s): 683a7e5

Refine README and rename unpack script

Browse files
Files changed (1) hide show
  1. README.md +7 -39
README.md CHANGED
@@ -23,7 +23,7 @@ benchmark_splits/
23
  test_nonexpert_unseen/video_progress_benchmark_file.json
24
 
25
  scripts/
26
- extract_vlac2_release_raw_archives.sh
27
  extract_vlac2_release_frames.py
28
 
29
  data/
@@ -36,15 +36,15 @@ data/
36
  ### 1. Unpack the video archives
37
 
38
  ```bash
39
- bash scripts/extract_vlac2_release_raw_archives.sh
40
  ```
41
 
42
- This command extracts `data/train_videos.tar` and `data/test_videos.tar` into `data/`, while preserving the relative directory structure expected by the benchmark release.
43
 
44
  To extract the raw videos elsewhere, pass a target directory:
45
 
46
  ```bash
47
- bash scripts/extract_vlac2_release_raw_archives.sh /path/to/data
48
  ```
49
 
50
  ### 2. Extract frames
@@ -55,25 +55,11 @@ python scripts/extract_vlac2_release_frames.py \
55
  --frames-root /path/to/data_extracted_frames
56
  ```
57
 
58
- This command reads raw videos from `/path/to/data` and writes extracted frames to `/path/to/data_extracted_frames`. Only the benchmark-designated main camera stream is materialized.
59
-
60
- For example, if the raw videos are unpacked to:
61
-
62
- ```text
63
- /path/to/release/data
64
- ```
65
-
66
- then the extracted frames will be written to:
67
-
68
- ```text
69
- /path/to/release/data_extracted_frames
70
- ```
71
-
72
- If `--frames-root` is omitted, frames are written to `_extracted_frames/` under the release directory by default.
73
 
74
  ### 3. Use the benchmark splits
75
 
76
- The benchmark JSON files are pre-generated and can be used directly. No benchmark reconstruction is required.
77
 
78
  Frame paths in the JSON files use the prefix:
79
 
@@ -81,25 +67,7 @@ Frame paths in the JSON files use the prefix:
81
  __VLAC2_FRAMES_ROOT__/
82
  ```
83
 
84
- Replace `__VLAC2_FRAMES_ROOT__` with the absolute path to the extracted-frame directory produced by the frame-extraction step.
85
-
86
- For example, if frames are extracted to:
87
-
88
- ```text
89
- /path/to/release/data_extracted_frames
90
- ```
91
-
92
- then:
93
-
94
- ```text
95
- __VLAC2_FRAMES_ROOT__/...
96
- ```
97
-
98
- should be resolved as:
99
-
100
- ```text
101
- /path/to/release/data_extracted_frames/...
102
- ```
103
 
104
  ## Notes
105
 
 
23
  test_nonexpert_unseen/video_progress_benchmark_file.json
24
 
25
  scripts/
26
+ unpack_data.sh
27
  extract_vlac2_release_frames.py
28
 
29
  data/
 
36
  ### 1. Unpack the video archives
37
 
38
  ```bash
39
+ bash scripts/unpack_data.sh
40
  ```
41
 
42
+ This command extracts `data/train_videos.tar` and `data/test_videos.tar` into `data/`.
43
 
44
  To extract the raw videos elsewhere, pass a target directory:
45
 
46
  ```bash
47
+ bash scripts/unpack_data.sh /path/to/data
48
  ```
49
 
50
  ### 2. Extract frames
 
55
  --frames-root /path/to/data_extracted_frames
56
  ```
57
 
58
+ This command extracts the benchmark main-view frames from `/path/to/data` into `/path/to/data_extracted_frames`. If `--frames-root` is omitted, frames are written to `_extracted_frames/` under the release directory.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
59
 
60
  ### 3. Use the benchmark splits
61
 
62
+ The benchmark JSON files are pre-generated and can be used directly.
63
 
64
  Frame paths in the JSON files use the prefix:
65
 
 
67
  __VLAC2_FRAMES_ROOT__/
68
  ```
69
 
70
+ Replace `__VLAC2_FRAMES_ROOT__` with the absolute path to the extracted-frame directory. For example, `__VLAC2_FRAMES_ROOT__/...` should be resolved as `/path/to/data_extracted_frames/...`.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
 
72
  ## Notes
73