Upload README.md with huggingface_hub

README.md

@@ -1,27 +1,59 @@
----
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: caption
-    dtype: string
-  - name: empty_image
-    dtype: image
-  - name: furniture_image
-    dtype: image
-  - name: shadow_image
-    dtype: image
-  - name: staged_image
-    dtype: image
-  splits:
-  - name: train
-    num_bytes: 775051021.0
-    num_examples: 100
-  download_size: 774843448
-  dataset_size: 775051021.0
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+# Autodesign Dataset
+
+A dataset of room designs in different states: empty, with furniture, with shadows, and staged.
+
+**TEST MODE: THIS IS A SAMPLE OF 100 ITEMS FROM THE FULL DATASET**
+
+## Dataset Structure
+
+Total examples: 100
+
+### Fields:
+- **id**: Unique identifier for each example
+- **caption**: Textual description/caption for the design
+- **empty_image**: Image of the empty room
+- **furniture_image**: Image of the room with furniture
+- **shadow_image**: Image of the room with shadows
+- **staged_image**: Image of the fully staged room
+
+## Usage Example
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("ApplyDesign/autodesign-dataset-test" if args.upload and args.hf_username else "YOUR_USERNAME/autodesign-dataset")
+
+# Access an example
+example = dataset['train'][0]
+print(example['caption'])
+
+# Display an image
+import matplotlib.pyplot as plt
+
+plt.figure(figsize=(15, 10))
+
+# Display all four image types
+plt.subplot(2, 2, 1)
+plt.imshow(example['empty_image'])
+plt.title('Empty Room')
+plt.axis('off')
+
+plt.subplot(2, 2, 2)
+plt.imshow(example['furniture_image'])
+plt.title('With Furniture')
+plt.axis('off')
+
+plt.subplot(2, 2, 3)
+plt.imshow(example['shadow_image'])
+plt.title('With Shadows')
+plt.axis('off')
+
+plt.subplot(2, 2, 4)
+plt.imshow(example['staged_image'])
+plt.title('Fully Staged')
+plt.axis('off')
+
+plt.tight_layout()
+plt.show()
+```