Update README.md

README.md

@@ -21,3 +21,49 @@ configs:
   - split: train
     path: data/train-*
 ---
+# Moroccan Darija Dataset (Filtered from FineWeb2)
+
+This dataset contains Moroccan Darija samples extracted from the [FineWeb2](https://huggingface.co/datasets/Omartificial-Intelligence-Space/FineWeb2-Moroccan-Arabic) dataset. 
+The extraction was performed using a [custom model](https://huggingface.co/atlasia/SfaIA-Arabic-Dialect-Identifier/tree/main/) trained to classify Arabic dialects, including Moroccan Darija (here we used the version `model_binary_v3_1fpr.bin`). 
+Here, we kept samples with a high confidence score (above 0.6) for Moroccan Darija.
+This dataset aims to advance research and development in Moroccan Darija NLP tasks.
+
+---
+
+## Dataset Description
+
+Moroccan Darija, a widely spoken Arabic dialect in Morocco, is underrepresented in NLP resources. This dataset fills that gap by filtering FineWeb2 using an advanced classifier designed to accurately identify Moroccan Darija text. The resulting dataset is a valuable resource for tasks such as:
+- Language modeling
+- Sentiment analysis
+- Machine translation
+- Dialectal classification
+
+---
+
+## Extraction Methodology
+
+1. **Base Dataset**: FineWeb2, a large-scale multilingual web dataset.
+1. **First extraction using GlotLID**: [A version](https://huggingface.co/datasets/Omartificial-Intelligence-Space/FineWeb2-Moroccan-Arabic) with extraction using GlotLID.
+2. **SfaIA Model**: A fasttext model trained to identify Arabic dialects, including Moroccan Darija with better performances than GlotLID.
+3. **Pipeline**:
+   - Text samples from the [dataset](https://huggingface.co/datasets/Omartificial-Intelligence-Space/FineWeb2-Moroccan-Arabic) were passed through the SfaIA classifier.
+   - Only samples with a high confidence score (above 0.6) for Moroccan Darija were retained.
+
+---
+
+## Dataset Structure
+
+- `text`: The raw text sample in Moroccan Darija.
+- `prediction`:
+   -  `prediction_confidence`: Model confidence score for each sample.
+   -  `prediction_label`: Model predicted label.
+
+Example entry:
+```json
+{
+  "text": "السلام عليكم، كيف دايرين؟",
+  "prediction": {
+      'prediction_confidence': 0.652466607093811, 
+      'prediction_label': 'Morocco'
+   }
+}