Upload README.md with huggingface_hub

README.md

@@ -26,15 +26,30 @@ Each preference pair stores a **preferred** image (`path1`) and a **non-preferre
 
 ```bash
 pip install -U "huggingface_hub[cli]"
-huggingface-cli download Junjun2333/HPDv3-PlusPlus --repo-type dataset --local-dir HPDv3pp
+hf download Junjun2333/HPDv3-PlusPlus --repo-type dataset --local-dir HPDv3pp
 cd HPDv3pp
-# Reassemble and extract the image pool (split tar parts):
+# Reassemble and extract our image pool (split tar parts -> images/qwen_image, images/rollout, images/thumbs):
 cat images.tar.part* | tar -xf -
 ```
 
+The split tar contains **only the images we generated** (`images/qwen_image/`,
+`images/rollout/`, `images/thumbs/`). The `stage1_ref.json` reference pairs point
+to the **original HPDv3 images** (`images/hpdv3/...`), which we do **not**
+re-host here. If you need them (only required to reproduce HPSv3++ Stage 1 with
+the original HPDv3 reference set), download the HPDv3 images from the official
+repo and place them under `images/hpdv3/`:
+
+```bash
+# Original HPDv3 images (only needed for stage1_ref.json)
+hf download MizzenAI/HPDv3 --repo-type dataset --include "images.tar.gz.*" --local-dir hpdv3_src
+cat hpdv3_src/images.tar.gz.* | gunzip | tar -xv   # then move/symlink the resulting images into images/hpdv3/
+```
+
 After extraction you get an `images/` directory. Every path in the JSON files
 (`path1` / `path2` / `image_path`) is **relative** and resolves against the
-repo root, e.g. `images/qwen_image/prompt_000000/6.jpg`.
+repo root, e.g. `images/qwen_image/prompt_000000/6.jpg`. The four ready-to-use
+train/test files (`train_aes`, `train_tf`, `test_aes`, `test_tf`) reference only
+our own images and need no HPDv3 download.
 
 ## What you can use directly
 
@@ -57,7 +72,7 @@ the two axes (aes/tf), so they can be used together without leakage.
 
 ```
 HPDv3-PlusPlus/
-|-- images.tar.part00, images.tar.part01, ...   # split tar of the image pool (~328 GB total)
+|-- images.tar.part00, images.tar.part01, ...   # split tar of OUR images (~268 GB; qwen_image + rollout + thumbs)
 |-- train/
 |   |-- train_aes.json        # 100,463  ready-to-use aesthetic training pairs
 |   |-- train_tf.json         # 90,908   ready-to-use text-following training pairs
@@ -69,7 +84,8 @@ HPDv3-PlusPlus/
 |-- test/
 |   |-- test_aes.json         # 5,720   ready-to-use aesthetic test pairs
 |   `-- test_tf.json          # 4,465   ready-to-use text-following test pairs
-`-- images/                   # (after extraction) the unified, deduplicated image pool
+`-- images/                   # after extraction: qwen_image/, rollout/, thumbs/ (ours);
+                              #   hpdv3/ must be downloaded separately from MizzenAI/HPDv3 (only for stage1_ref)
 ```
 
 ## JSON formats
@@ -97,9 +113,11 @@ HPDv3-PlusPlus/
 
 ## Notes
 
-- The full image pool is ~328 GB (922,699 deduplicated images). If you only need
-  the ready-to-use train/test files, you still need the image pool, since the
-  JSONs reference images by relative path.
+- The images we host here (`qwen_image` + `rollout` + `thumbs`) are ~268 GB. The
+  original HPDv3 images (`hpdv3/`, ~60 GB, referenced only by `stage1_ref.json`)
+  are not re-hosted -- download them from MizzenAI/HPDv3 if needed (see Quick start).
+- The ready-to-use train/test files reference only our own images, so they work
+  with just the split tar above (no HPDv3 download needed).
 - For the full two-stage training / evaluation pipeline (which additionally uses
   `rollout.json`, `stage1_ref.json`, etc.), see the HPSv3++ code repository.