Update README.md

README.md

@@ -16,29 +16,27 @@ model-index:
       args: plain_text
 ---
 
-<!-- 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. -->
+
+
+
+
 
 # t5-end2end-question-generation
 
-This model is a fine-tuned version of [t5-base](https://huggingface.co/t5-base) on the squad dataset.
+This model is a fine-tuned version of [t5-base](https://huggingface.co/t5-base) on the squad dataset to generate questions based on a context.
+
 It achieves the following results on the evaluation set:
 - Loss: 1.5691
 
+If you want to learn how to fine-tune t5 model to do the same, you can follow this [tutorial](https://colab.research.google.com/drive/1z-Zl2hftMrFXabYfmz8o9YZpgYx6sGeW?usp=sharing)
+
 ## 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."
+text= "The abolition of feudal privileges by the National Constituent Assembly on 4 August 1789 and the Declaration \\nof the Rights of Man and of the Citizen (La Déclaration des Droits de l'Homme et du Citoyen), drafted by Lafayette \\nwith the help of Thomas Jefferson and adopted on 26 August, paved the way to a Constitutional Monarchy \\n(4 September 1791 – 21 September 1792). Despite these dramatic changes, life at the court continued, while the situation \\nin Paris was becoming critical because of bread shortages in September. On 5 October 1789, a crowd from Paris descended upon Versailles \\nand forced the royal family to move to the Tuileries Palace in Paris, where they lived under a form of house arrest under \\nthe watch of Lafayette's Garde Nationale, while the Comte de Provence and his wife were allowed to reside in the \\nPetit Luxembourg, where they remained until they went into exile on 20 June 1791."
 
 def run_model(input_string, **generator_args):
   generator_args = {
@@ -65,20 +63,6 @@ run_model(text)
 
 ```
 
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
-
 ### Training hyperparameters
 
 The following hyperparameters were used during training: