Update README.md

README.md

@@ -2,33 +2,34 @@
 license: apache-2.0
 tags:
 - generated_from_trainer
+metrics: 
+- nl2bash_m
 model-index:
 - name: byt5-small-finetuned-English-to-BASH
   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. -->
-
 # byt5-small-finetuned-English-to-BASH
+Created by: [Josh Shih](https://huggingface.co/Josh98), [Alex Sha](https://huggingface.co/alexsha), [Kevin Um](https://huggingface.co/kevinum) for EEP 596 - Natural Language Processing at University of Washington (Seattle).
 
-This model is a fine-tuned version of [google/byt5-small](https://huggingface.co/google/byt5-small) on the None dataset.
+## Model description
+This model is a fine-tuned version of [google/byt5-small](https://huggingface.co/google/byt5-small) on a more balanced iteration of the [NL2BASH](https://github.com/TellinaTool/nl2bash/tree/master/data) dataset.
 It achieves the following results on the evaluation set:
 - Loss: 0.4850
 - Nl2bash M: 0.6376
 - Gen Len: 16.9946
 
-## Model description
-
-More information needed
-
 ## Intended uses & limitations
-
-More information needed
+Purpose: To generate bash commands from text input, and help people learn to use linux bash. This is a proof of concept model using transfer learning to fine-tune an existing language model and produce structured code instead of natural language. 
 
 ## Training and evaluation data
 
-More information needed
+This model was trained and evaluated using a custom iteration of [NL2BASH](https://github.com/TellinaTool/nl2bash/tree/master/data). The original NL2BASH dataset contains a large class imbalance with too many bash commands which begin with 'find'. 
+
+A maximum threshold was set to remove text/BASH pairs which exceeded the threshold, and [GPT-3](https://openai.com/blog/gpt-3-apps/) API was used to generate text/BASH pairs for those below the threshold.
+
+~5500 original text/BASH pairs and ~5700 generated text/BASH pairs were used, giving a total of ~11200 lines of text/BASH pairs. Shown below is the class distribution for the top-5 commands.
+![class_balanced.png](https://s3.amazonaws.com/moonup/production/uploads/1677215336540-63d8b9876ac3104e50cd9634.png)
 
 ## Training procedure