Update the STAR dataset description

README.md

@@ -174,54 +174,53 @@ dataset_info:
   dataset_size: 39523806
 ---
 
-# STAR Relationship
+# STAR Scene Graph Dataset
 
-STAR Relationship 是一个遥感场景图生成（Scene Graph Generation，SGG）数据集。仓库将原始大尺寸图片与结构化标注分开保存：
+STAR（Scene graph generaTion in lArge-size satellite imageRy）是面向大幅高分辨率卫星影像场景图生成的数据集。本仓库依据官方 SGG-ToolKit 发布的 `STAR-SGG-with-attri.h5`、taxonomy 和图片元数据构建。
 
-- 图片以普通文件形式位于 `images/`。
-- train、validation 和 test 的结构化标注以 Parquet 保存。
-- Dataset 中的 `image` 字段是图片相对于仓库根目录的路径，不包含图片字节，也不会自动解码为 PIL 对象。
+图片作为仓库普通文件保存在 `images/`，Parquet 中的 `image` 字段是仓库相对路径，不包含图片字节，也不会自动解码为 Pillow 对象。完整仓库约 127 GB，下载前请确认磁盘空间。
 
-完整仓库约为 127 GB。使用 `snapshot_download()` 下载完整仓库前，请确认本地有足够的磁盘空间。
+## Split
 
-## 仓库结构
+本仓库严格使用 H5 的内部 `split` 标记，并将官方测试标记作为 Hugging Face validation 发布：
 
-```text
-wliafe/star
-├── README.md
-├── images
-│   ├── train
-│   │   └── 0000.png
-│   ├── validation
-│   │   └── 0002.png
-│   └── test
-│       └── 0004.png
-└── data
-    ├── train-*.parquet
-    ├── validation-*.parquet
-    └── test-*.parquet
-```
+| Hugging Face split | H5 标记 | 图片 | 对象 | 关系 |
+| --- | ---: | ---: | ---: | ---: |
+| `train` | `0` | 700 | 123,117 | 214,322 |
+| `validation` | `2` | 573 | 96,003 | 187,044 |
+| **总计** |  | **1,273** | **219,120** | **401,366** |
 
-本地源数据中的 `val` 在 Hugging Face Dataset 中命名为 `validation`。
+仓库不提供 `test` split。`validation` 包含完整对象和关系 ground truth。
 
-## 数据字段
+## 字段
 
-每行表示一张图片及其场景图标注：
+每行对应一张图片：
 
-- `id`：图片文件名去除扩展名后的样本 ID。
+- `id`：四位图片 ID。
 - `image`：仓库相对路径，例如 `images/train/0000.png`。
-- `width`、`height`：原图宽高。
-- `polygons`：对象 polygon 列表；每个点为 `[x, y]`，保留原始坐标和顶点顺序。
-- `labels`：与 `polygons` 一一对应的对象类别。
-- `relations.subject_index`：关系主语在对象数组中的索引。
-- `relations.object_index`：关系宾语在对象数组中的索引。
-- `relations.predicate`：关系类别。
+- `width`、`height`：图片的实际像素尺寸。
+- `boxes`：与对象平行的 `[x1, y1, x2, y2]` 水平框。
+- `polygons`：与对象平行的四点 polygon，每点为 `[x, y]`。
+- `labels`：对象类别。
+- `attributes`：每个对象对应的 10 个官方属性槽；0 是 padding/background。
+- `relations.subject_index`、`relations.object_index`：关系端点在当前对象数组中的零基索引。
+- `relations.predicate`：关系谓词类别。
+
+`boxes`、`polygons`、`labels` 和 `attributes` 长度相同。三个 `relations` 数组也彼此平行。本仓库保留 H5 的所有关系；不会执行训练代码中可选的重复关系随机采样。
+
+原始目录中的 1273 个文件均使用 `.png` 扩展名；其中 1179 个实际采用 PNG 编码、94 个实际采用 JPEG 编码。发布过程通过硬链接保留官方源文件字节，不执行转码。
+
+## SGG-ToolKit 坐标约定
 
-test split 只有图片，`polygons`、`labels` 和三个关系数组均为空。
+公开字段遵循官方 SGG-ToolKit 的 H5 读取规则：
 
-## 下载并读取
+- `boxes_2000` 由中心点—宽高转换为角点框后乘以 `6000 / 2000`。
+- `segmentation_2000` 同样乘以 `6000 / 2000`，并保留原始四点顺序。
+- H5 中的全局关系端点已转换成每张图片内部的零基对象索引。
 
-`repo_type="dataset"` 是 `snapshot_download()` 的参数；`load_dataset()` 直接使用仓库 ID，不需要传入 `repo_type`。
+对象、谓词和属性 taxonomy 均在索引 0 保留 `__background__`。H5 的前景标签已经从 1 开始，因此其前景整数编号保持不变。
+
+## 下载与读取
 
 ```python
 from pathlib import Path
@@ -230,26 +229,22 @@ from datasets import load_dataset
 from huggingface_hub import snapshot_download
 
 
-repo_dir = Path(
+revision = "main"
+repository = Path(
     snapshot_download(
-        repo_id="wliafe/star",
+        repo_id="wliafe/STAR",
         repo_type="dataset",
+        revision=revision,
     )
 )
-dataset = load_dataset("wliafe/star")
+dataset = load_dataset("wliafe/STAR", revision=revision)
 
 sample = dataset["train"][0]
-image_path = repo_dir / sample["image"]
-
-print(sample["id"])
-print(sample["image"])
-print(image_path)
-assert image_path.is_file()
+image_path = repository / sample["image"]
+print(sample["id"], image_path, sample["width"], sample["height"])
 ```
 
-`snapshot_download()` 返回仓库快照根目录，因此将它与 `sample["image"]` 拼接即可得到本地图片路径。不要直接把相对路径解释为当前工作目录下的文件。
-
-### 使用 Pillow
+使用 Pillow 打开图片：
 
 ```python
 from PIL import Image
@@ -260,40 +255,26 @@ with Image.open(image_path) as image:
     print(image.size)
 ```
 
-### 使用 OpenCV
-
-```python
-import cv2
-
-
-image = cv2.imread(str(image_path), cv2.IMREAD_UNCHANGED)
-if image is None:
-    raise RuntimeError(f"无法读取图片：{image_path}")
-print(image.shape)
-```
-
-## 固定数据版本
+训练或评测时，`snapshot_download()` 与 `load_dataset()` 应使用同一个完整 commit revision，以保证图片和 Parquet 标注来自同一版本。
 
-如果训练或评测需要可复现的数据版本，请为下载和 Dataset 加载指定同一个完整 commit revision：
+## 使用限制
 
-```python
-from pathlib import Path
-
-from datasets import load_dataset
-from huggingface_hub import snapshot_download
+- STAR 类别与谓词存在长尾分布。
+- 大尺寸遥感影像需要较多下载空间、内存和 I/O 带宽。
+- 标注可能包含遗漏、歧义或类别噪声。
+- 使用者应遵守 STAR 原始发布方的许可、引用和使用要求。
 
+## 引用
 
-revision = "<full-commit-sha>"
-repo_dir = Path(
-    snapshot_download(
-        repo_id="wliafe/star",
-        repo_type="dataset",
-        revision=revision,
-    )
-)
-dataset = load_dataset("wliafe/star", revision=revision)
-
-image_path = repo_dir / dataset["train"][0]["image"]
+```bibtex
+@article{li2025star,
+  title={STAR: A First-Ever Dataset and a Large-Scale Benchmark for Scene Graph Generation in Large-Size Satellite Imagery},
+  author={Li, Yansheng and Wang, Linlin and Wang, Tingzhu and others},
+  journal={IEEE Transactions on Pattern Analysis and Machine Intelligence},
+  volume={47},
+  number={3},
+  pages={1832--1849},
+  year={2025},
+  doi={10.1109/TPAMI.2024.3508072}
+}
 ```
-
-这样 Parquet 标注与原始图片始终来自同一个仓库版本。