Document the Visual Genome scene graph dataset

README.md

@@ -457,3 +457,114 @@ configs:
   - split: test
     path: data/test-*
 ---
+
+
+# Visual Genome Scene Graph Dataset
+
+该仓库提供经过结构化处理的 Visual Genome 场景图数据集，可直接通过 Hugging Face `datasets` 加载。数据采用常用的 VG150 类别体系，包含 150 个前景对象类别、50 个前景关系类别和 200 个前景属性类别；每组类别还包含索引为 0 的 `__background__`。
+
+## 数据划分
+
+| Split | 样本数 |
+| --- | ---: |
+| train | 62,407 |
+| validation | 8,915 |
+| test | 17,832 |
+| **合计** | **89,154** |
+
+仓库下载大小约为 12.7 GB。图片直接嵌入 Parquet，因此 `image` 字段由 Hugging Face 解码为 PIL 图片对象。
+
+## 字段说明
+
+每行表示一张图片及其场景图：
+
+- `id`：样本 ID。
+- `image`：Hugging Face `Image` 字段，读取样本时返回 PIL 图片。
+- `width`、`height`：图片宽高。
+- `boxes`：对象边界框，格式为 `[x_min, y_min, x_max, y_max]`。
+- `labels`：与 `boxes` 一一对应的对象类别 ID。
+- `attributes`：与对象一一对应的属性类别 ID 列表。
+- `relations.subject_index`：关系主语在对象数组中的索引。
+- `relations.object_index`：关系宾语在对象数组中的索引。
+- `relations.predicate`：关系类别 ID。
+
+对象、属性和关系均使用 `ClassLabel`，可以通过 Dataset 的 `features` 取得类别名称。
+
+## 加载数据
+
+```python
+from datasets import load_dataset
+
+
+dataset = load_dataset("wliafe/vg")
+print(dataset)
+
+sample = dataset["train"][0]
+print(sample["id"])
+print(sample["image"].size)
+print(len(sample["boxes"]))
+print(len(sample["relations"]["predicate"]))
+```
+
+如需避免立即解码图片，可以先把 `image` 字段转换为 `decode=False`：
+
+```python
+from datasets import Image, load_dataset
+
+
+dataset = load_dataset("wliafe/vg")
+dataset = dataset.cast_column("image", Image(decode=False))
+
+sample = dataset["train"][0]
+print(sample["image"])
+```
+
+## 读取类别名称
+
+```python
+from datasets import load_dataset
+
+
+dataset = load_dataset("wliafe/vg")
+features = dataset["train"].features
+
+object_names = features["labels"].feature.names
+attribute_names = features["attributes"].feature.feature.names
+predicate_names = features["relations"]["predicate"].feature.names
+
+sample = dataset["train"][0]
+for subject_index, object_index, predicate_id in zip(
+    sample["relations"]["subject_index"],
+    sample["relations"]["object_index"],
+    sample["relations"]["predicate"],
+):
+    subject_label = object_names[sample["labels"][subject_index]]
+    object_label = object_names[sample["labels"][object_index]]
+    predicate = predicate_names[predicate_id]
+    print(f"{subject_label} --{predicate}--> {object_label}")
+```
+
+## 标注约定
+
+- 边界框会裁剪到图片范围内。
+- 裁剪后面积为零的对象不会保留。
+- 引用已删除对象的关系不会保留。
+- 关系端点保存为当前对象数组的索引，而不是 Visual Genome 的原始对象 ID。
+- `boxes`、`labels` 和 `attributes` 使用相同的对象顺序。
+
+## 引用
+
+如果该数据集对你的研究有帮助，请引用 Visual Genome：
+
+```bibtex
+@article{krishna2017visual,
+  title={Visual Genome: Connecting Language and Vision Using Crowdsourced Dense Image Annotations},
+  author={Krishna, Ranjay and Zhu, Yuke and Groth, Oliver and Johnson, Justin and Hata, Kenji and Kravitz, Joshua and Chen, Stephanie and Kalantidis, Yannis and Li, Li-Jia and Shamma, David A. and Bernstein, Michael S. and Fei-Fei, Li},
+  journal={International Journal of Computer Vision},
+  volume={123},
+  pages={32--73},
+  year={2017}
+}
+```
+
+数据的使用许可和适用范围请以 Visual Genome 官方发布条款为准。