Update README.md

README.md

@@ -8,9 +8,6 @@ model-index:
   results: []
 ---
 
-<!-- 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. -->
-
 # codebert-base-Password_Strength_Classifier
 
 This model is a fine-tuned version of [microsoft/codebert-base](https://huggingface.co/microsoft/codebert-base) on the None dataset.
@@ -29,15 +26,20 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+The model classifies passwords as one of the following:
+1) Weak
+2) Medium
+3) Strong
+
+For more information on how it was created, check out the following link: https://github.com/DunnBC22/NLP_Projects/blob/main/Password%20Strength%20Classification%20(MC)/CodeBERT-Base%20-%20Password_Classifier.ipynb
 
 ## Intended uses & limitations
 
-More information needed
+This is intended to show the possibilities. It is mainly limited by the input data.
 
 ## Training and evaluation data
 
-More information needed
+Dataset Source: https://www.kaggle.com/datasets/bhavikbb/password-strength-classifier-dataset
 
 ## Training procedure
 
@@ -60,7 +62,6 @@ The following hyperparameters were used during training:
 | 0.0133        | 2.0   | 16742 | 0.0092          | 0.9966   | 0.9967      | 0.9966   | 0.9951   | 0.9966          | 0.9966       | 0.9966       | 0.9967             | 0.9966          | 0.9935          |
 | 0.0067        | 3.0   | 25113 | 0.0077          | 0.9975   | 0.9975      | 0.9975   | 0.9963   | 0.9975          | 0.9975       | 0.9978       | 0.9975             | 0.9975          | 0.9948          |
 
-
 ### Framework versions
 
 - Transformers 4.27.4