Update README.md

README.md

@@ -20,7 +20,38 @@ dataset_info:
     num_examples: 11738819
   download_size: 3092363938
   dataset_size: 7357785049
+license: cc-by-4.0
 ---
 # Dataset Card for "arabic_punctuation"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Dataset Details
+
+### Dataset Description
+
+
+This is a curated dataset, specifically designed to facilitate the study of punctuation. It has undergone rigorous manual annotation and verification on the basis of sentence structure, with sentence boundaries clearly marked.  The dataset is in three folders:
+
+1. The ABC component of the Arabic Punctuation Dataset: This folder features the manually annotated punctuation gold standard. It consists of one chapter extracted from each of 45 non-fiction books by 36 authors from 19 different fields of study. It contains 45 text files with a total of 149K tokens in 13K sentences. 
+
+2. The CBT component: This folder has 1085 text files in 60  sub-folders, the full text of complete book translations that had been rendered from English into Arabic independently of this project. Their punctuation, we found out, mirrors the English source language texts; i.e., the sentence terminals in these Arabic texts follow the rules of English. In this folder are close to 3M words in more than 170K properly punctuated sentences.
+
+3. The SSAC-UNPC component: This folder constitutes the third part of the Arabic Punctuation Dataset. It has close to 12M disconnected, disordered, complete sentences in 79 text files. These scrambled sentences were extracted from the predominantly legal Arabic subcorpus of the United Nations Parallel Corpus (UNPC). The punctuation here is authentic. It was done by the UN translators as part of their work. We consider this to be an excellent punctuation corpus because it mirrors the rule-governed punctuation of the English source documents, especially in relation to sentence terminals. These scrambled sentences total more than 309M words.
+
+### Steps to reproduce
+
+The ABC component was manually annotated and verified.
+The CBT dataset was translated books extracted from an online library.
+The SSAC-UNPC dataset was full sentences extracted from the Arabic component of the United Nations Parallel Corpus.
+
+## Citation
+```
+@misc{Yagi_Ashraf Elnagar_2024,
+ url={https://data.mendeley.com/datasets/2pkxckwgs3/1},
+ journal={Arabic Punctuation Dataset},
+ publisher={Mendeley Data},
+ author={Yagi, Sane and Ashraf Elnagar},
+ year={2024},
+month={Jan}}
+
+```