Add dataset README

README.md

@@ -1,24 +1,128 @@
----
-license: cc-by-nc-4.0
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: room_instances
-    list:
-      list: uint8
-  - name: interior_mask
-    list:
-      list: uint8
-  splits:
-  - name: train
-    num_bytes: 23258890
-    num_examples: 10000
-  download_size: 1100811
-  dataset_size: 23258890
----
+---
+license: other
+task_categories:
+  - image-segmentation
+tags:
+  - floorplan
+  - rplan
+  - architecture
+  - parquet
+size_categories:
+  - 1K<n<10K
+---
+
+# rPlan Floorplan Dataset (32x32, 10K subset)
+
+A subset of 10,000 floorplan images from the rPlan dataset, resized to 32x32 pixels.
+Stored as compressed Parquet with numpy arrays for efficient loading.
+
+## Dataset Format
+
+Each sample contains:
+- **id**: Image identifier (string)
+- **room_instances**: 32x32 uint8 numpy array - room instance segmentation (35 unique classes)
+- **interior_mask**: 32x32 uint8 numpy array - interior/exterior mask (255 = interior, 0 = exterior)
+
+## Room Instance Color Mapping (35 Classes)
+
+| Class ID | Color Value | Class Name |
+|----------|-------------|------------|
+| 0 | 0 | Living Room |
+| 1 | 7 | Master Room_0 |
+| 2 | 15 | Master Room_1 |
+| 3 | 22 | Master Room_2 |
+| 4 | 30 | Master Room_3 |
+| 5 | 37 | Master Room_4 |
+| 6 | 45 | Kitchen_0 |
+| 7 | 52 | Kitchen_1 |
+| 8 | 60 | Bathroom_0 |
+| 9 | 67 | Bathroom_1 |
+| 10 | 75 | Bathroom_2 |
+| 11 | 82 | Dining Room_0 |
+| 12 | 90 | Dining Room_1 |
+| 13 | 97 | Child Room_0 |
+| 14 | 105 | Child Room_1 |
+| 15 | 112 | Child Room_2 |
+| 16 | 120 | Study Room_0 |
+| 17 | 127 | Study Room_1 |
+| 18 | 135 | Study Room_2 |
+| 19 | 142 | Second Room_0 |
+| 20 | 150 | Second Room_1 |
+| 21 | 157 | Second Room_2 |
+| 22 | 165 | Second Room_3 |
+| 23 | 172 | Guest Room_0 |
+| 24 | 180 | Guest Room_1 |
+| 25 | 187 | Guest Room_2 |
+| 26 | 195 | Balcony_0 |
+| 27 | 202 | Balcony_1 |
+| 28 | 210 | Balcony_2 |
+| 29 | 217 | Balcony_3 |
+| 30 | 225 | Entrance |
+| 31 | 232 | Storage_0 |
+| 32 | 240 | Storage_1 |
+| 33 | 247 | Storage_2 |
+| 34 | 255 | External Area |
+
+## Usage
+
+```python
+from datasets import load_dataset
+import numpy as np
+
+# Load the dataset
+ds = load_dataset("Cybernaut101/rPlan_subset_10000")
+
+# Access a sample
+sample = ds["train"][0]
+room_instances = np.array(sample["room_instances"])  # 32x32 uint8
+interior_mask = np.array(sample["interior_mask"])    # 32x32 uint8
+
+# Iterate over the dataset
+for sample in ds["train"]:
+    room_instances = np.array(sample["room_instances"])
+    interior_mask = np.array(sample["interior_mask"])
+    # ... your processing here
+
+# Color value -> class name mapping
+ROOM_INSTANCE_COLOR_MAP = {
+    0: "living room",
+    7: "master room_0",
+    15: "master room_1",
+    22: "master room_2",
+    30: "master room_3",
+    37: "master room_4",
+    45: "kitchen_0",
+    52: "kitchen_1",
+    60: "bathroom_0",
+    67: "bathroom_1",
+    75: "bathroom_2",
+    82: "dining room_0",
+    90: "dining room_1",
+    97: "child room_0",
+    105: "child room_1",
+    112: "child room_2",
+    120: "study room_0",
+    127: "study room_1",
+    135: "study room_2",
+    142: "second room_0",
+    150: "second room_1",
+    157: "second room_2",
+    165: "second room_3",
+    172: "guest room_0",
+    180: "guest room_1",
+    187: "guest room_2",
+    195: "balcony_0",
+    202: "balcony_1",
+    210: "balcony_2",
+    217: "balcony_3",
+    225: "entrance",
+    232: "storage_0",
+    240: "storage_1",
+    247: "storage_2",
+    255: "external area",
+}
+```
+
+## License
+
+Please refer to the original rPlan dataset license for usage terms.