Update README.md

README.md

@@ -2,13 +2,14 @@
 tags:
 - generated_from_trainer
 model-index:
-- name: arwiki_mlm
+- name: arRoBERTa
   results: []
 metrics:
 - perplexity
 license: mit
 datasets:
-- SaiedAlshahrani/Arabic_Wikipedia_20230101
+- SaiedAlshahrani/Arabic_Wikipedia_20230101_bots
+- SaiedAlshahrani/MASD
 language:
 - ar
 library_name: transformers
@@ -20,27 +21,52 @@ widget:
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
 should probably proofread and complete it, then remove this comment. -->
 
-# arwiki_mlm (arRoBERTa)
+# Arabic Wikipedia (arRoBERTa<sub>BASE</sub>)
 
-This model is a fine-tuned version of [](https://huggingface.co/) on an unknown dataset.
+This arRoBERTa<sub>BASE</sub> model has been trained *from scratch* on the Arabic Wikipedia articles, downloaded on the 1st of January 2023, processed using
+`Gensim` Python library, preprocessed using `tr` Linux/Unix utility and `CAMeLTools` Python toolkit for Arabic NLP, and hosted here at [SaiedAlshahrani/Arabic_Wikipedia_20230101_bots](https://huggingface.co/datasets/SaiedAlshahrani/Arabic_Wikipedia_20230101_bots).
 It achieves the following results on the evaluation set:
 
-- Pseudo-Perplexity: 
+- Pseudo-Perplexity: 23.70
+
 
 ## Model description
 
-More information needed
+We trained this Arabic Wikipedia Masked Language Model (arRoBERTa<sub>BASE</sub>) to evaluate its performance using the Fill-Mask evaluation task and the Masked Arab States Dataset ([MASD](https://huggingface.co/datasets/SaiedAlshahrani/MASD)) dataset and measure the *impact* of **template-based translation** on the Egyptian Arabic Wikipedia edition.
+
+For more details about the experiment, please **read** and **cite** our paper:
+
+```bash
+@inproceedings{alshahrani-etal-2023-implications,
+    title = "{{Performance Implications of Using Unrepresentative Corpora in Arabic Natural Language Processing}}",
+    author = "Alshahrani, Saied and Alshahrani, Norah and Dey, Soumyabrata and Matthews, Jeanna",
+    booktitle = "Proceedings of the The First Arabic Natural Language Processing Conference (ArabicNLP 2023)",
+    month = dec,
+    year = "2023",
+    address = "Singapore (Hybrid)",
+    publisher = "Association for Computational Linguistics",
+    url = "https://webspace.clarkson.edu/~alshahsf/unrepresentative_corpora.pdf",
+    doi = "#################",
+    pages = "###--###",
+    abstract = "Wikipedia articles are a widely used source of training data for Natural Language Processing (NLP) research, particularly as corpora for low-resource languages like Arabic. However, it is essential to understand the extent to which these corpora reflect the representative contributions of native speakers, especially when many entries in a given language are directly translated from other languages or automatically generated through automated mechanisms. In this paper, we study the performance implications of using inorganic corpora that are not representative of native speakers and are generated through automated techniques such as bot generation or automated template-based translation. The case of the Arabic Wikipedia editions gives a unique case study of this since the Moroccan Arabic Wikipedia edition (ARY) is small but representative, the Egyptian Arabic Wikipedia edition (ARZ) is large but unrepresentative, and the Modern Standard Arabic Wikipedia edition (AR) is both large and more representative. We intrinsically evaluate the performance of two main NLP upstream tasks, namely word representation and language modeling, using word analogy evaluations and fill-mask evaluations using our two newly created datasets: Arab States Analogy Dataset (ASAD) and Masked Arab States Dataset (MASD). We demonstrate that for good NLP performance, we need both large and organic corpora; neither alone is sufficient. We show that producing large corpora through automated means can be a counter-productive, producing models that both perform worse and lack cultural richness and meaningful representation of the Arabic language and its native speakers.",
+}
+```
+
 
 ## Intended uses & limitations
 
-More information needed
+We do **not** recommend using this model because it was trained *only* on the Arabic Wikipedia articles, <u>unless</u> you fine-tune the model on a large, organic, and representative Arabic dataset.
+
 
 ## Training and evaluation data
 
-More information needed
+We have trained this model on the Arabic Wikipedia articles ([SaiedAlshahrani/Arabic_Wikipedia_20230101_bots](https://huggingface.co/datasets/SaiedAlshahrani/Arabic_Wikipedia_20230101_bots)) without using any validation or evaluation data (only training data) due to a lack of computational power.
+
 
 ## Training procedure
 
+We have trained this model using the Paperspace GPU-Cloud service. We used a machine with 8 CPUs, 45GB RAM, and A6000 GPU with 48GB RAM.
+
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
@@ -69,6 +95,13 @@ The following hyperparameters were used during training:
 
 
 
+### Evaluation results
+This arRoBERTa<sub>BASE</sub> model has been evaluated on the Masked Arab States Dataset ([SaiedAlshahrani/MASD](https://huggingface.co/datasets/SaiedAlshahrani/MASD)).
+| K=10 | K=50  | K=100 | 
+|:----:|:-----:|:----:|
+| 43.12%| 45% | 50.62% | 
+ 
+
 ### Framework versions
 
 - Datasets 2.9.0