Update README.md

README.md

@@ -8,26 +8,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 [Salesforce/codet5-small](https://huggingface.co/Salesforce/codet5-small) on an unknown dataset.
+This model is a fine-tuned version of [Salesforce/codet5-small](https://huggingface.co/Salesforce/codet5-small) on [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 on the dataset referred to above
 
 ### Training hyperparameters
 
@@ -43,10 +45,6 @@ The following hyperparameters were used during training:
 - num_epochs: 1
 - mixed_precision_training: Native AMP
 
-### Training results
-
-
-
 ### Framework versions
 
 - Transformers 4.35.0