futurefantasy commited on
Commit
adc84f9
·
verified ·
1 Parent(s): 4008484

Refine README inference usage and argument descriptions

Browse files
Files changed (2) hide show
  1. README.md +12 -1
  2. quick_start/README.md +15 -3
README.md CHANGED
@@ -49,10 +49,21 @@ Run progress inference on an arbitrary video:
49
 
50
  ```bash
51
  python quick_start/run_example.py \
 
52
  --video-path /path/to/video.mp4 \
53
- --task-instruction "把洋葱放进快递箱里。"
 
 
54
  ```
55
 
 
 
 
 
 
 
 
 
56
  Render a prediction-only preview video from the JSONL output:
57
 
58
  ```bash
 
49
 
50
  ```bash
51
  python quick_start/run_example.py \
52
+ --model-path /path/to/VLAC-Cut-Qwen3VL-30B-A3B-Progress \
53
  --video-path /path/to/video.mp4 \
54
+ --task-instruction "<natural-language task instruction>" \
55
+ --task-plan $'<optional step-by-step task plan>' \
56
+ --output-jsonl quick_start/outputs/video.jsonl
57
  ```
58
 
59
+ - `--video-path`: required input video.
60
+ - `--task-instruction`: task description, unless `--prompt` is used instead.
61
+ - `--task-plan`: optional step-by-step plan text for the default `chunk_all` prompt.
62
+ - `--model-path`: optional. Defaults to the parent directory of `quick_start/`.
63
+ - `--output-jsonl`: optional. Defaults to `quick_start/outputs/<video_stem>.jsonl`.
64
+ - `--prompt`: optional full prompt override.
65
+ - `--sample-hz`, `--max-new-tokens`: optional inference controls.
66
+
67
  Render a prediction-only preview video from the JSONL output:
68
 
69
  ```bash
quick_start/README.md CHANGED
@@ -23,10 +23,24 @@ Run inference:
23
 
24
  ```bash
25
  python quick_start/run_example.py \
 
26
  --video-path /path/to/video.mp4 \
27
- --task-instruction "把洋葱放进快递箱里。"
 
 
28
  ```
29
 
 
 
 
 
 
 
 
 
 
 
 
30
  Render a preview video:
31
 
32
  ```bash
@@ -35,8 +49,6 @@ python quick_start/render_prediction_video.py \
35
  --output-video quick_start/outputs/video_pred_progress.mp4
36
  ```
37
 
38
- If the model directory is not the parent of `quick_start/`, pass `--model-path`.
39
-
40
  ## Bundled Examples
41
 
42
  `example_01`
 
23
 
24
  ```bash
25
  python quick_start/run_example.py \
26
+ --model-path /path/to/VLAC-Cut-Qwen3VL-30B-A3B-Progress \
27
  --video-path /path/to/video.mp4 \
28
+ --task-instruction "<natural-language task instruction>" \
29
+ --task-plan $'<optional step-by-step task plan>' \
30
+ --output-jsonl quick_start/outputs/video.jsonl
31
  ```
32
 
33
+ Important arguments:
34
+
35
+ - `--video-path`: required. Input video path.
36
+ - `--task-instruction`: optional if `--prompt` is provided. Natural-language task description.
37
+ - `--task-plan`: optional. Multi-line plan text appended after `--task-instruction` when building the default `chunk_all` prompt.
38
+ - `--model-path`: optional. Defaults to the parent directory of `quick_start/`.
39
+ - `--output-jsonl`: optional. Defaults to `quick_start/outputs/<video_stem>.jsonl`.
40
+ - `--sample-hz`: optional. Video sampling rate for inference. Default: `2.0`.
41
+ - `--max-new-tokens`: optional. Generation cap. Default: `1024`.
42
+ - `--prompt`: optional full prompt override. If set, `--task-instruction` and `--task-plan` are ignored.
43
+
44
  Render a preview video:
45
 
46
  ```bash
 
49
  --output-video quick_start/outputs/video_pred_progress.mp4
50
  ```
51
 
 
 
52
  ## Bundled Examples
53
 
54
  `example_01`