Update README.md

README.md

@@ -9,6 +9,8 @@ model-index:
 - name: llama3-conciser
   results: []
 pipeline_tag: text2text-generation
+datasets:
+- chrislee973/llama3-conciser-dataset
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -135,23 +137,26 @@ hub_model_id: chrislee973/llama3-conciser
 
 # llama3-conciser
 
-This model is a fine-tuned version of [NousResearch/Meta-Llama-3-8B](https://huggingface.co/NousResearch/Meta-Llama-3-8B) on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.5174
-
-## Model description
-
-More information needed
-
-## Intended uses & limitations
+This model is a fine-tuned version of [NousResearch/Meta-Llama-3-8B](https://huggingface.co/NousResearch/Meta-Llama-3-8B) on my [conciser dataset](https://huggingface.co/datasets/chrislee973/llama3-conciser-dataset).
 
-More information needed
+## Uses
 
-## Training and evaluation data
+### Text Revision task
+Given an input of a paragraph of text from a transcript, it lightly touches up and edits the sentences and phrases, 
+improving the flow and readability of the text while maintaining the speaker's original intention.
 
-More information needed
+For example, given the following input text:
+```
+I think I sort of deep down believed in what we were doing, and I did some analysis. I was like, okay, well, what would I go do if I wasn't doing this? It's like, well, I really like building things, and I like helping people communicate, and I like understanding what's going on with people and the dynamics between people. So I think if I sold this company, I'd just go build another company like this. And I kind of like the one I have.
+```
+the revised output text is:
+```
+I believed deep down in what we were doing. I did some analysis. What would I go do if I wasn’t doing this? I really like building things, helping people communicate, understanding what’s going on with people and the dynamics between them. If I sold this company, I’d just go build another one like this. I kind of like the one I have.
+```
+There are still some rough edges around the model as a result of my dataset being so tiny (just 50 examples). I hope to smooth these imperfections out and close the quality gap by adding many more examples to the dataset. 
 
-## Training procedure
+## Usage
+TODO: add sample inference code
 
 ### Training hyperparameters