Upload README.md

README.md

@@ -1,21 +1,131 @@
 ---
-dataset_info:
-  features:
-  - name: id
-    dtype: int64
-  - name: story_name
-    dtype: string
-  - name: content
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 369368510
-    num_examples: 4392
-  download_size: 187408474
-  dataset_size: 369368510
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+language:  
+  - ary  
+task_categories:  
+  - text-generation  
+multilinguality:  
+  - monolingual  
+language_creators:  
+  - machine-translated  
+source_datasets:  
+  - original  
+size_categories:  
+  - 1K<n<10K  
+
 ---
+
+# Dataset Card for DarijaStory
+
+## Table of Contents
+
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+
+## Dataset Description
+
+- **Repository:** [https://hf.co/datasets/MBZUAI-Paris/DarijaStory](https://hf.co/datasets/MBZUAI-Paris/DarijaStory)
+- **Paper:** [https://arxiv.org/pdf/2409.17912](https://arxiv.org/pdf/2409.17912)
+
+### Dataset Summary
+
+DarijaStory is a story completion dataset. It consists of 4,392 long stories scraped from [9esa](https://www.9esa.com), a website featuring a variety of stories written in Moroccan Darija. 
+
+### Supported Tasks and Leaderboards
+
+- **Task Category:** Conditional Text Generation
+- **Task:** Story Completion in Moroccan Darija
+
+### Languages
+
+The dataset is available in Moroccan Arabic (Darija).
+
+## Dataset Structure
+
+### Data Instances
+
+Each data instance contains a story or a chapter of story.
+
+#### Example Data Instance:
+
+```
+{
+  'id': 1170,
+  'story_name': 'قصة اللؤلؤة السوداء',
+  'content': 'حلات عوييناتها بتقااالة... حاسة بحرييق كيقطع فراااسها... قوي وعينيها مضببين ليها رؤيا ... هزات يديها بتقالة حطاتها فوق رااسها....'
+}
+```
+
+### Data Fields
+
+- **id**: *(integer)* Index of the story.
+- **story_name**: *(string)* The story name.
+- **content**: *(integer)* The content of the story.
+
+### Data Splits
+
+The dataset consists of a single split:
+
+| Split | Number of Instances |
+|-------|----------------------|
+| train  | 4,392               |
+
+## Dataset Creation
+
+### Curation Rationale
+
+The dataset was web-scraped from [9esa.com](https://www.9esa.com) that contains stories in Darija.
+
+
+### Personal and Sensitive Information
+
+The dataset does not contain personal, private, or sensitive information. All stories are general and cover fictional or societal themes relevant to Morocco.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+This dataset promotes the development and evaluation of language models capable of understanding and generating extended narratives in Moroccan Darija, thus contributing to the advancement of NLP in underrepresented languages and supporting cultural diversity in AI applications.
+
+### Discussion of Biases
+
+The dataset consists of Moroccan Darija stories, which may reflect specific cultural and societal themes relevant to Morocco. Users should be aware of these biases when using the dataset for general language model applications.
+
+## Additional Information
+
+### Dataset Curators
+
+- **MBZUAI-Paris Team**
+
+### Licensing Information
+
+- **License:** [ODC-BY](https://opendatacommons.org/licenses/by/1-0/).
+
+
+### Citation Information
+
+If you use this dataset, please cite:
+
+```
+@dataset{darijastory2024,
+  title={DarijaStory: A Moroccan Arabic (Darija) Story Completion Dataset},
+  author={MBZUAI-Paris team},
+  year={2024},
+  howpublished={\url{https://hf.co/datasets/MBZUAI-Paris/DarijaStory}}
+}
+```