Update README.md

README.md

@@ -20,15 +20,11 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
-
-## Intended uses & limitations
-
-More information needed
+This model summarizes the diary.
 
 ## Training and evaluation data
 
-More information needed
+This model was trained by the self-instruction process. All data used for fine-tuning this model were generated by chatGPT 3.5.
 
 ## Training procedure
 
@@ -61,3 +57,14 @@ The following hyperparameters were used during training:
 - Pytorch 2.1.2+cu118
 - Datasets 2.16.1
 - Tokenizers 0.15.0
+
+
+### How to Get Started with the Model
+Use the code below to get started with the model. You can adjust hyperparameters to fit on your data.
+'''
+def diary_summary(text):
+  input_ids = tokenizer.encode(text, return_tensors = 'pt').to(device)
+  summary_text_ids = model.generate(input_ids = input_ids, bos_token_id = model.config.bos_token_id, eos_token_id = model.config.eos_token_id,
+                                    length_penalty = 2.0, max_length = 150, num_beams = 2)
+  return tokenizer.decode(summary_text_ids[0], skip_special_tokens = True)
+'''