Update README.md

README.md

@@ -7,28 +7,28 @@ 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. -->
-
 # training
 
-This model is a fine-tuned version of [huggingface/CodeBERTa-small-v1](https://huggingface.co/huggingface/CodeBERTa-small-v1) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.1370
+This model is a fine-tuned version of [huggingface/CodeBERTa-small-v1](https://huggingface.co/huggingface/CodeBERTa-small-v1) on an [my own techdebt dataset](https://huggingface.co/datasets/davidgaofc/techdebt).
 
 ## Model description
 
-More information needed
+Classifies cleaned diffs of code.
+* 1: exhibits possible technical debt
+* 0: is probably clean
 
 ## Intended uses & limitations
 
-More information needed
+Limited by many things probably, use with caution. Improvements in progress.
 
 ## Training and evaluation data
 
-More information needed
+~95% accurate on the test split of dataset above
+~.94 F1 score on test split of dataset above.
+
 
 ## Training procedure
+One epoch of training done on the dataset above.
 
 ### Training hyperparameters
 
@@ -41,10 +41,6 @@ The following hyperparameters were used during training:
 - lr_scheduler_type: linear
 - num_epochs: 1
 
-### Training results
-
-
-
 ### Framework versions
 
 - Transformers 4.35.0