Update README.md

README.md

@@ -24,17 +24,41 @@ It achieves the following results on the evaluation set:
 - Rougelsum: 85.4236
 - Bleu: 72.1080
 
+See: [https://wandb.ai/domenicrosati/huggingface/runs/n1yallpe](https://wandb.ai/domenicrosati/huggingface/runs/n1yallpe)
+
 ## Model description
 
-More information needed
+A t5-model model to convert questions, answer pairs into statements.
+
+The input should be all lower case and punctuation removed.
+Use with `. ` as the seperator between question and answer.
+> "where in the world is carmen. abruzzo"
+> Output: "carmen is in abruzzo"
+
+```
+from transformers import AutoTokenizer,  AutoModelForSeq2SeqLM
+
+tokenizer = AutoTokenizer.from_pretrained('domenicrosati/QA2D-t5-small')
+model = AutoModelForSeq2SeqLM.from_pretrained('domenicrosati/QA2D-t5-small')
+
+question = "where in the world is carmen sandiego"
+answer = "she is in abruzzo"
+SEP = ". "
+
+prompt = f'{question}{SEP}{answer}'
+input_ids = tokenizer(prompt, return_tensors='pt').input_ids
+output_ids = model.generate(input_ids)
+responses = tokenizer.batch_decode(output_ids, skip_special_tokens=True)
+# ['carmen sandiego is in abruzzo']
+```
 
 ## Intended uses & limitations
 
-More information needed
+To convert questions, answer pairs into statements.
 
 ## Training and evaluation data
 
-More information needed
+Uses [QA2D](https://huggingface.co/datasets/domenicrosati/QA2D).
 
 ## Training procedure