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

Document custom frame output root

Browse files
Files changed (1) hide show
  1. README.md +10 -12
README.md CHANGED
@@ -50,18 +50,14 @@ bash scripts/extract_vlac2_release_raw_archives.sh /path/to/data
50
  ### 2. Extract frames
51
 
52
  ```bash
53
- python scripts/extract_vlac2_release_frames.py --data-root /path/to/data
 
 
54
  ```
55
 
56
- This command reads raw videos from `/path/to/data` and writes extracted frames to `_extracted_frames/` under the release directory. The output location is fixed by the release package and does not need to be specified explicitly. Only the benchmark-designated main camera stream is materialized.
57
 
58
- For example, if the release directory is:
59
-
60
- ```text
61
- /path/to/release
62
- ```
63
-
64
- and the raw videos are unpacked to:
65
 
66
  ```text
67
  /path/to/release/data
@@ -70,9 +66,11 @@ and the raw videos are unpacked to:
70
  then the extracted frames will be written to:
71
 
72
  ```text
73
- /path/to/release/_extracted_frames
74
  ```
75
 
 
 
76
  ### 3. Use the benchmark splits
77
 
78
  The benchmark JSON files are pre-generated and can be used directly. No benchmark reconstruction is required.
@@ -88,7 +86,7 @@ Replace `__VLAC2_FRAMES_ROOT__` with the absolute path to the extracted-frame di
88
  For example, if frames are extracted to:
89
 
90
  ```text
91
- /path/to/release/_extracted_frames
92
  ```
93
 
94
  then:
@@ -100,7 +98,7 @@ __VLAC2_FRAMES_ROOT__/...
100
  should be resolved as:
101
 
102
  ```text
103
- /path/to/release/_extracted_frames/...
104
  ```
105
 
106
  ## Notes
 
50
  ### 2. Extract frames
51
 
52
  ```bash
53
+ python scripts/extract_vlac2_release_frames.py \
54
+ --data-root /path/to/data \
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
 
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.
 
86
  For example, if frames are extracted to:
87
 
88
  ```text
89
+ /path/to/release/data_extracted_frames
90
  ```
91
 
92
  then:
 
98
  should be resolved as:
99
 
100
  ```text
101
+ /path/to/release/data_extracted_frames/...
102
  ```
103
 
104
  ## Notes