Update README.md

README.md

@@ -5,28 +5,31 @@ tags:
 model-index:
 - name: bert-base-uncased-Masked_Language_Modeling-Reddit_Comments
   results: []
+language:
+- en
+metrics:
+- perplexity
 ---
 
-<!-- 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. -->
-
 # bert-base-uncased-Masked_Language_Modeling-Reddit_Comments
 
-This model is a fine-tuned version of [bert-base-uncased](https://huggingface.co/bert-base-uncased) on the None dataset.
+This model is a fine-tuned version of [bert-base-uncased](https://huggingface.co/bert-base-uncased).
 It achieves the following results on the evaluation set:
 - Loss: 2.5415
 
 ## Model description
 
-More information needed
+This is a masked language modeling project.
+
+For more information on how it was created, check out the following link: https://github.com/DunnBC22/NLP_Projects/blob/main/Masked%20Language%20Model/Datasets%20for%20NLP%20-%20Reddit%20Comments/Datasets_for_NLP_MLM.ipynb
 
 ## Intended uses & limitations
 
-More information needed
+This model is intended to demonstrate my ability to solve a complex problem using technology.
 
 ## Training and evaluation data
 
-More information needed
+Dataset Source: https://www.kaggle.com/datasets/toygarr/datasets-for-natural-language-processing
 
 ## Training procedure
 
@@ -49,10 +52,11 @@ The following hyperparameters were used during training:
 | 2.6818        | 2.0   | 21624 | 2.5699          |
 | 2.6103        | 3.0   | 32436 | 2.5402          |
 
+Perplexity: 12.70
 
 ### Framework versions
 
 - Transformers 4.27.0
 - Pytorch 1.13.1+cu116
 - Datasets 2.10.1
-- Tokenizers 0.13.2
+- Tokenizers 0.13.2