Upload README.md with huggingface_hub

README.md

@@ -25,37 +25,61 @@ ParaVT is a multi-agent agentic framework for long-video understanding, post-tra
 
 ## Layout
 
-Files are grouped by sentinel bucket (matching the path scheme used by [`paravt.data.sanitize`](https://github.com/mwxely/ParaVT/blob/paravt-release/paravt/data/sanitize.py)). Each bucket's archives extract directly into a directory tree that the [`paravt.data.materialize`](https://github.com/mwxely/ParaVT/blob/paravt-release/paravt/data/materialize.py) helper can re-attach to absolute paths in a single call.
+Files are grouped by sentinel bucket (matching the path scheme used by [`paravt.data.sanitize`](https://github.com/mwxely/ParaVT/blob/paravt-release/paravt/data/sanitize.py)). Each archive's members are stored under their full sentinel-form path, so extracting every zip into a single root produces a unified tree that [`paravt.data.materialize`](https://github.com/mwxely/ParaVT/blob/paravt-release/paravt/data/materialize.py) can re-link in one call.
 
 | Bucket | Contents | Archive convention |
 |---|---|---|
 | `longvt_source/<src>/` | LongVT shared training clips (`videor1_*`, `longvideoreason_*`, `geminicot_*`, `tvg_*`, `selftrace_*`) | `<src>_<idx>.zip`, mirroring the [`longvideotool/LongVT-Source`](https://huggingface.co/datasets/longvideotool/LongVT-Source) naming |
+| `longvt_source/videor1_<N>/...` *(images)* | Auxiliary image files (`.png` / `.jpg`) referenced by the multi-modal interleaved rows in `paravt_sft_videor1_50k.parquet` | `videor1_<N>_images.zip` (one per `videor1_<N>` bucket) |
 | `museg/charades/` | Charades-STA clips used by the `charades` SFT split and the `charades_tvg` RL split | `charades_<idx>.zip` |
 | `museg/et_instruct_164k/` | MuSeG `et_instruct_164k` clips used by the `museg` SFT split | `et_instruct_<idx>.zip` |
 | `selfqa/` | Self-curated open-ended QA clips (HACS- and Ego4D-derived UUIDs / YouTube IDs) used by the `hacs` and `ego4d_naq` RL splits | `selfqa.zip` (single archive, ~6 GB) |
 
-Each archive is sized to stay below 10 GB on disk so that LFS pointer + Cloudflare CDN serving stays well-behaved.
+Each archive is sized to stay below 10 GB on disk so that LFS pointer + Cloudflare CDN serving stays well-behaved. The `<src>_<idx>.zip` and `videor1_<N>_images.zip` archives that share a `videor1_<N>` prefix unzip into disjoint subdirectories of the same `videor1_<N>/` tree (videos under `CLEVRER/`, `LLaVA-Video-178K/`, … and images under `Chart/`, `Math/`, `Knowledge/`, `OCR/`, …), so they don't overwrite each other.
 
 ## Usage
 
 ```bash
+# 1. Download every archive (use --include for a subset; see below).
 huggingface-cli download ParaVT/ParaVT-Source --repo-type dataset --local-dir ./paravt-source
 
-# Selective: pull only the buckets you need (e.g. charades grounding only)
-huggingface-cli download ParaVT/ParaVT-Source \
-    --repo-type dataset --local-dir ./paravt-source \
-    --include "museg/charades/*"
-
-# Extract zips in place
-( cd ./paravt-source && for z in */*.zip; do unzip -q -d "$(dirname "$z")" "$z"; done )
+# 2. Extract every zip into the same root. Each zip's arcname carries the
+#    full sentinel path (e.g. "longvt_source/videor1_7/Math/...png"), so the
+#    extraction target must be the top-level root, NOT the per-zip directory.
+( cd ./paravt-source && find . -name "*.zip" -exec unzip -q -o -d . {} \; )
 
-# Re-link absolute paths inside the parquets (one shot; see ParaVT/ParaVT-Parquet)
+# 3. Re-link absolute paths inside the parquets (one shot; see ParaVT/ParaVT-Parquet).
 python -m paravt.data.materialize \
     --root        ./paravt-source \
     --parquet-dir ./paravt-parquet \
     --output-dir  ./paravt-parquet-materialized
+
+# Selective: pull only the buckets you need (e.g. Charades grounding only).
+# Materialize will warn on missing files but produce valid output for the
+# subset that is present.
+huggingface-cli download ParaVT/ParaVT-Source \
+    --repo-type dataset --local-dir ./paravt-source \
+    --include "museg/charades.zip"
 ```
 
+After step 2 the directory tree under `./paravt-source/` looks like:
+
+```
+paravt-source/
+├── longvt_source/
+│   ├── videor1_<N>/             # mp4 from videor1_<N>.zip + png/jpg from videor1_<N>_images.zip
+│   │   ├── CLEVRER/, LLaVA-Video-178K/, NeXT-QA/, ...   # videos
+│   │   └── Chart/, Math/, Knowledge/, OCR/, ...         # images
+│   ├── longvideoreason_<N>/     # from longvideoreason_<N>_part{1,2}.zip
+│   ├── geminicot_<N>/, tvg_<N>/, selftrace_<N>/, ...
+├── museg/
+│   ├── charades/                # mp4 from museg/charades.zip
+│   └── et_instruct_164k/        # mp4 from museg/et_instruct.zip
+└── selfqa/                      # mp4 from selfqa/selfqa.zip
+```
+
+The materialized parquets then point at `file://<absolute-path-to-paravt-source>/<sentinel-path>` for every row.
+
 ## Citation
 
 ```bibtex