Upload README.md with huggingface_hub

README.md

@@ -1,35 +1,108 @@
 ---
-dataset_info:
-  features:
-  - name: text
-    dtype: string
-  - name: context
-    dtype: string
-  - name: eou_label
-    dtype: int64
-  - name: dialect
-    dtype: string
-  - name: __index_level_0__
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 873111
-    num_examples: 9328
-  - name: validation
-    num_bytes: 109056
-    num_examples: 1166
-  - name: test
-    num_bytes: 111223
-    num_examples: 1166
-  download_size: 492203
-  dataset_size: 1093390
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: validation
-    path: data/validation-*
-  - split: test
-    path: data/test-*
+language: ar
+license: mit
+task_categories:
+- text-classification
+tags:
+- arabic
+- eou-detection
+- conversation
+- multi-dialect
+- levantine
+- egyptian
+- gulf
+size_categories:
+- 10K<n<100K
 ---
+
+# Arabic EOU Conversations Dataset
+
+Multi-dialect Arabic conversation dataset for End-of-Utterance (EOU) detection.
+
+## Dataset Description
+
+This dataset contains Arabic conversational examples labeled for end-of-utterance detection.
+It includes natural dialogue patterns across three major Arabic dialects.
+
+**Key Features:**
+- **Total Examples**: 11,660 (balanced 50/50 EOU/NOT_EOU)
+- **Dialects**: Levantine (شامي), Egyptian (مصري), Gulf (خليجي)
+- **Format**: Conversation pairs with EOU labels
+- **Split**: 80% train, 10% validation, 10% test
+
+## Dataset Structure
+
+Each example contains:
+- `text`: The utterance text in Arabic
+- `label`: Binary label (0 = NOT_EOU, 1 = EOU)
+- `context`: Optional previous utterance for context
+
+### Example
+
+```json
+{
+  "text": "شو رأيك نروح نتغدا؟",
+  "label": 1,
+  "context": ""
+}
+```
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+# Load dataset
+dataset = load_dataset("Reverb/arabic-eou-conversations")
+
+# Access splits
+train_data = dataset["train"]
+val_data = dataset["validation"]
+test_data = dataset["test"]
+
+# Example
+print(train_data[0])
+```
+
+## Data Collection
+
+The dataset was curated from Arabic conversational data across three dialects:
+- **Levantine**: Conversational Arabic from the Levant region
+- **Egyptian**: Egyptian colloquial Arabic
+- **Gulf**: Gulf Arabic dialects
+
+## Intended Use
+
+This dataset is designed for:
+- Training EOU detection models
+- Turn-taking research in Arabic dialogue
+- Voice assistant development
+- Conversational AI systems
+- Arabic NLP research
+
+## Limitations
+
+- Focused on conversational/colloquial Arabic
+- May not represent all Arabic dialects equally
+- Designed for spoken language patterns
+- Not suitable for formal/literary Arabic
+
+## Citation
+
+```bibtex
+@misc{arabic-eou-dataset,
+  author = {Reverb},
+  title = {Arabic EOU Conversations Dataset},
+  year = {2025},
+  publisher = {Hugging Face},
+  url = {https://huggingface.co/datasets/Reverb/arabic-eou-conversations}
+}
+```
+
+## License
+
+MIT License
+
+## Related Models
+
+This dataset was used to train: [Reverb/smollm2-135m-arabic-eou](https://huggingface.co/Reverb/smollm2-135m-arabic-eou)