Update README.md

README.md

@@ -4,30 +4,23 @@ tags:
 model-index:
 - name: bert-base-irish-cased-v1
   results: []
+widget:
+- text: "Ceoltóir [MASK] ab ea Johnny Cash."
 ---
 
-<!-- This model card has been generated automatically according to the information Keras had access to. You should
-probably proofread and complete it, then remove this comment. -->
 
 # bert-base-irish-cased-v1
 
-This model was trained from scratch on an unknown dataset.
-It achieves the following results on the evaluation set:
-
+[gaBERT](https://arxiv.org/abs/2107.12930) is a BERT-base model trained on 7.9M Irish sentences. For more details, including the hyperparameters and pretraining corpora used please refer to our paper.
 
 ## Model description
 
-More information needed
+Encoder-based Transformer to be used to obtain features for finetuning for downstream tasks in Irish.
 
 ## Intended uses & limitations
 
-More information needed
-
-## Training and evaluation data
+Some data used to pretrain gaBERT was scraped from the web which potentially contains ethically problematic text (bias, hate, adult content, etc.). Consequently, downstream tasks/applications using gaBERT should be thoroughly tested with respect to ethical considerations.
 
-More information needed
-
-## Training procedure
 
 ### Training hyperparameters
 
@@ -35,8 +28,6 @@ The following hyperparameters were used during training:
 - optimizer: None
 - training_precision: float32
 
-### Training results
-
 
 
 ### Framework versions