Upload README.md with huggingface_hub

README.md

@@ -1,70 +1,91 @@
 ---
-dataset_info:
-  features:
-  - name: image
-    dtype: image
-  - name: mask
-    dtype: image
-  - name: width
-    dtype: int64
-  - name: height
-    dtype: int64
-  - name: class_labels
-    sequence: string
-  splits:
-  - name: train
-    num_bytes: 712358851.6
-    num_examples: 3600
-  - name: val
-    num_bytes: 173422466.0
-    num_examples: 900
-  - name: test
-    num_bytes: 169073024.0
-    num_examples: 900
-  - name: partition_train_0.01x_partition
-    num_bytes: 7031346.0
-    num_examples: 36
-  - name: partition_train_0.02x_partition
-    num_bytes: 14208668.0
-    num_examples: 72
-  - name: partition_train_0.50x_partition
-    num_bytes: 355787333.6
-    num_examples: 1800
-  - name: partition_train_0.20x_partition
-    num_bytes: 142530938.0
-    num_examples: 720
-  - name: partition_train_0.05x_partition
-    num_bytes: 35446977.0
-    num_examples: 180
-  - name: partition_train_0.10x_partition
-    num_bytes: 71167216.0
-    num_examples: 360
-  - name: partition_train_0.25x_partition
-    num_bytes: 177965582.0
-    num_examples: 900
-  download_size: 1856106813
-  dataset_size: 1858992402.1999998
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: val
-    path: data/val-*
-  - split: test
-    path: data/test-*
-  - split: partition_train_0.01x_partition
-    path: data/partition_train_0.01x_partition-*
-  - split: partition_train_0.02x_partition
-    path: data/partition_train_0.02x_partition-*
-  - split: partition_train_0.50x_partition
-    path: data/partition_train_0.50x_partition-*
-  - split: partition_train_0.20x_partition
-    path: data/partition_train_0.20x_partition-*
-  - split: partition_train_0.05x_partition
-    path: data/partition_train_0.05x_partition-*
-  - split: partition_train_0.10x_partition
-    path: data/partition_train_0.10x_partition-*
-  - split: partition_train_0.25x_partition
-    path: data/partition_train_0.25x_partition-*
+annotations_creators:
+- expert-generated
+language_creators:
+- found
+language:
+- en
+license:
+- cc-by-4.0
+multilinguality:
+- monolingual
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- image-segmentation
+task_ids:
+- semantic-segmentation
+pretty_name: mb-crater_binary_seg
 ---
+
+# mb-crater_binary_seg
+
+A segmentation dataset for planetary science applications.
+
+## Dataset Metadata
+
+* **License:** CC-BY-4.0 (Creative Commons Attribution 4.0 International)
+* **Version:** 1.0
+* **Date Published:** 2025-05-15
+* **Cite As:** TBD
+
+## Classes
+
+This dataset contains the following classes:
+
+- 0: Background
+- 1: Crater
+
+## Directory Structure
+
+The dataset follows this structure:
+
+```
+dataset/
+  ├── train/
+  │   ├── images/  # Image files
+  │   └── masks/   # Segmentation masks
+  ├── val/
+  │   ├── images/  # Image files
+  │   └── masks/   # Segmentation masks
+  ├── test/
+  │   ├── images/  # Image files
+  │   └── masks/   # Segmentation masks
+```
+
+## Statistics
+
+- train: 3600 images
+- val: 900 images
+- test: 900 images
+- partition_train_0.01x_partition: 36 images
+- partition_train_0.02x_partition: 72 images
+- partition_train_0.50x_partition: 1800 images
+- partition_train_0.20x_partition: 720 images
+- partition_train_0.05x_partition: 180 images
+- partition_train_0.10x_partition: 360 images
+- partition_train_0.25x_partition: 900 images
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("Mirali33/mb-crater_binary_seg")
+```
+
+## Format
+
+Each example in the dataset has the following format:
+
+```
+{
+  'image': Image(...),      # PIL image
+  'mask': Image(...),       # PIL image of the segmentation mask
+  'width': int,             # Width of the image
+  'height': int,            # Height of the image
+  'class_labels': [str,...] # List of class names present in the mask
+}
+```