Update README.md

README.md

@@ -2,7 +2,17 @@
 language: ar
 tags:
 - qarib
-
+- pytorch
+- tf
+datasets:
+- arabic_billion_words
+- open_subtitles
+- twitter
+metrics:
+- f1
+widget:
+ - text: " شو عندكم يا [MASK] ."
+---
 license: apache-2.0
 datasets:
 - Arabic GigaWord
@@ -26,11 +36,11 @@ For Tweets, the data was collected using twitter API and using language filter.
 ## Training QARiB
 The training of the model has been performed using Google’s original Tensorflow code on Google Cloud TPU v2.
 We used a Google Cloud Storage bucket, for persistent storage of training data and models.
-See more details in [Training QARiB](../Training_QARiB.md)
+See more details in [Training QARiB](https://github.com/qcri/QARIB/Training_QARiB.md)
 
 ## Using QARiB
 
-You can use the raw model for either masked language modeling or next sentence prediction, but it's mostly intended to be fine-tuned on a downstream task. See the model hub to look for fine-tuned versions on a task that interests you. For more details, see [Using QARiB](../Using_QARiB.md)
+You can use the raw model for either masked language modeling or next sentence prediction, but it's mostly intended to be fine-tuned on a downstream task. See the model hub to look for fine-tuned versions on a task that interests you. For more details, see [Using QARiB](https://github.com/qcri/QARIB/Using_QARiB.md)
 
 ### How to use
 You can use this model directly with a pipeline for masked language modeling:
@@ -85,12 +95,21 @@ We evaluated QARiB models on five NLP downstream task:
 
 The results obtained from QARiB models outperforms multilingual BERT/AraBERT/ArabicBERT.
 
-
 ## Model Weights and Vocab Download
-TBD
+
+From Huggingface site: https://huggingface.co/qarib/qarib/bert-base-qarib60_1790k
 
 ## Contacts
 
 Ahmed Abdelali, Sabit Hassan, Hamdy Mubarak, Kareem Darwish and Younes Samih
 
+## Reference
+```
+@article{abdelali2020qarib,
+  title={QARiB: QCRI Arabic and Dialectal BERT},
+  author={Ahmed, Abdelali and Sabit, Hassan and Hamdy, Mubarak and Kareem, Darwish and Younes, Samih},
+  link={https://github.com/qcri/QARIB},
+  year={2020}
+}
+```