Add docs/vlac2_public_release.md

docs/vlac2_public_release.md

@@ -0,0 +1,104 @@
+# VLAC2 Public Release
+
+这是一个最小使用说明，主要说明拿到发布包后怎么放数据、怎么抽帧、以及后续该用哪个 benchmark JSON。
+
+## 发布包包含什么
+
+```text
+vlac2_release/
+├── benchmark_json/
+├── vlac2_release_data/
+├── _extracted_frames/
+├── scripts/
+└── docs/
+```
+
+- `benchmark_json/`
+  - 公开提供的 benchmark 文件。
+  - 包含 `train/` 和 4 个 `test_*` bucket。
+- `vlac2_release_data/`
+  - 放原始数据集视频和相关原始文件。
+  - 发布包只保留目录结构，真实数据需要你自己补进去。
+- `_extracted_frames/`
+  - 抽帧后的 JPG 会写到这里。
+  - `_GENERATED` 只是一个标记文件，表示这个目录由程序生成。
+- `scripts/extract_vlac2_release_frames.py`
+  - 用户拿到包后需要运行的抽帧脚本。
+
+## 基础使用
+
+### 1. 放原始数据
+
+把原始数据按原有相对结构放到：
+
+```text
+<release-root>/vlac2_release_data/
+```
+
+例如：
+
+```text
+<release-root>/vlac2_release_data/ARX-data/...
+<release-root>/vlac2_release_data/libero/...
+<release-root>/vlac2_release_data/libero_zty50/...
+```
+
+### 2. 运行抽帧
+
+在 release 根目录下运行：
+
+```bash
+python scripts/extract_vlac2_release_frames.py --release-root /path/to/vlac2_release
+```
+
+默认行为：
+
+- 自动读取 `benchmark_json/` 里的 benchmark 文件
+- 自动找到对应原始视频
+- 把抽出的帧写到 `_extracted_frames/...`
+- 图片命名格式为：
+  - `{frame_idx}-{num_frames}.jpg`
+
+如果只想抽 benchmark 主视角，可以运行：
+
+```bash
+python scripts/extract_vlac2_release_frames.py \
+  --release-root /path/to/vlac2_release \
+  --view-mode main-only
+```
+
+如果想强制重抽已经存在的帧，可以运行：
+
+```bash
+python scripts/extract_vlac2_release_frames.py \
+  --release-root /path/to/vlac2_release \
+  --overwrite-existing
+```
+
+## 后续使用哪个文件
+
+后续测评只使用：
+
+- `benchmark_json/.../video_progress_benchmark_file.json`
+
+不需要用户自己重建 benchmark JSON。
+
+## 路径说明
+
+`video_progress_benchmark_file.json` 里的图片路径使用占位前缀：
+
+- `__VLAC2_RELEASE_ROOT__/_extracted_frames/...`
+
+实际使用时，把它替换成你本地 release 根目录的绝对路径即可。例如：
+
+- `__VLAC2_RELEASE_ROOT__/_extracted_frames/...`
+- `/abs/path/to/vlac2_release/_extracted_frames/...`
+
+## 依赖
+
+抽帧脚本至少需要一个解码后端：
+
+- `opencv-python`
+- 或 `imageio`
+
+如果两者都没有安装，脚本会直接报错退出。