Update README.md

README.md

@@ -25,6 +25,46 @@ This model is a fine-tuned version of [t5-base](https://huggingface.co/t5-base)
 It achieves the following results on the evaluation set:
 - Loss: 1.5691
 
+## Use the Model
+```
+from transformers import T5ForConditionalGeneration, T5TokenizerFast
+
+hfmodel = T5ForConditionalGeneration.from_pretrained("ThomasSimonini/t5-end2end-question-generation")
+
+text= "The abolition of feudal privileges by the National Constituent Assembly on 4 August 1789 and the Declaration \
+of the Rights of Man and of the Citizen (La Déclaration des Droits de l'Homme et du Citoyen), drafted by Lafayette \
+with the help of Thomas Jefferson and adopted on 26 August, paved the way to a Constitutional Monarchy \
+(4 September 1791 – 21 September 1792). Despite these dramatic changes, life at the court continued, while the situation \
+in Paris was becoming critical because of bread shortages in September. On 5 October 1789, a crowd from Paris descended upon Versailles \
+and forced the royal family to move to the Tuileries Palace in Paris, where they lived under a form of house arrest under \
+the watch of Lafayette's Garde Nationale, while the Comte de Provence and his wife were allowed to reside in the \
+Petit Luxembourg, where they remained until they went into exile on 20 June 1791."
+
+def run_model(input_string, **generator_args):
+  generator_args = {
+  "max_length": 256,
+  "num_beams": 4,
+  "length_penalty": 1.5,
+  "no_repeat_ngram_size": 3,
+  "early_stopping": True,
+  }
+  input_string = "generate questions: " + input_string + " </s>"
+  input_ids = tokenizer.encode(input_string, return_tensors="pt")
+  res = hfmodel.generate(input_ids, **generator_args)
+  output = tokenizer.batch_decode(res, skip_special_tokens=True)
+  output = [item.split("<sep>") for item in output]
+  return output
+  
+run_model(text)
+
+=> [['When did the National Constituent Assembly abolish feudal privileges?',
+  ' Who drafted the Declaration of the Rights of Man and of the Citizen?',
+  ' When was the Constitutional Monarchy established?',
+  ' What was the name of the Declaration that paved the way to a constitutional monarchy?',
+  '']]
+
+```
+
 ## Model description
 
 More information needed