Update README.md

README.md

@@ -5,7 +5,43 @@ tags:
 - generated_from_trainer
 model-index:
 - name: t5-small-squad-qg
-  results: []
+  results:
+  - task:
+      type: text2text-generation
+    metrics:
+      - name: BLEU
+        type: BLEU
+        value: 16.07
+      - name: Rouge1
+        type: Rouge1
+        value: 43.14
+      - name: Rouge2
+        type: Rouge2
+        value: 22.13
+      - name: RougeL
+        type: RougeL
+        value: 40.09
+      - name: RougeLSum
+        type: RougeLSum
+        value: 40.10
+      - name: METEOR
+        type: METEOR
+        value: 40.24
+      - name: BertScore
+        type: BertScore
+        value: 91.22
+widget:
+- text: "Generate a question whose answer is highlighted by <h> from the context delimited by the triple backticks \ncontext:```During the 2011–12 season, he set the La Liga and European records for most goals scored in a single season, while establishing himself as Barcelona all-time top scorer. The following two seasons, Messi finished second for the Ballon d'Or behind Cristiano Ronaldo (his perceived career rival), before regaining his best form during the 2014–15 campaign, becoming the all-time top scorer in La Liga and leading Barcelona to a historic second treble, after which he was awarded a fifth Ballon d'Or in 2015. Messi assumed captaincy of Barcelona in 2018, and won a record sixth Ballon d'Or in 2019. Out of contract, he signed for French club Paris Saint-Germain in August 2021, spending two seasons at the club and winning Ligue 1 twice. Messi joined American club  <h> Inter Miami <h> in July 2023, winning the Leagues Cup in August of that year.```"
+datasets:
+- rajpurkar/squad
+language:
+- en
+metrics:
+- bleu
+- rouge
+- meteor
+- bertscore
+pipeline_tag: text2text-generation
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -16,6 +52,13 @@ should probably proofread and complete it, then remove this comment. -->
 This model is a fine-tuned version of [t5-small](https://huggingface.co/t5-small) on the None dataset.
 It achieves the following results on the evaluation set:
 - Loss: 2.1731
+- BLEU: 16.07
+- Rouge1: 43.14
+- Rouge2: 22.13
+- RougeL: 40.09
+- RougeLSum: 40.10
+- METEOR: 40.24
+- BertScore: 91.22
 
 ## Model description
 
@@ -23,7 +66,87 @@ More information needed
 
 ## Intended uses & limitations
 
-More information needed
+1. Define some useful functions for highlighting the answer in the paragraph and preparing the instruction prompt that will be fed to the model:
+
+```Python
+def highlight_answer(context, answer):
+    context_splits = context.split(answer)
+    
+    text = ""
+    for split in context_splits:
+        text += split
+        text += ' <h> '
+        text += answer
+        text += ' <h> '
+        text += split
+    
+    return text
+
+def prepare_instruction(answer_highlighted_context):
+    instruction_prompt = f"""Generate a question whose answer is highlighted by <h> from the context delimited by the triple backticks.
+    context:
+    ```
+    {answer_highlighted_context}
+    ```
+    """
+    
+    return instruction_prompt
+```
+
+2. Use the model as a Hugging Face Pipeline:
+
+```Python
+from transformers import pipeline
+
+pipe = pipeline('text2text-generation', model='mohammedaly2222002/t5-small-squad-qg')
+
+context = """During the 2011–12 season, he set the La Liga and European records\
+for most goals scored in a single season, while establishing himself as Barcelona's\
+all-time top scorer. The following two seasons, Messi finished second for the Ballon\
+d'Or behind Cristiano Ronaldo (his perceived career rival), before regaining his best\
+form during the 2014–15 campaign, becoming the all-time top scorer in La Liga and \
+leading Barcelona to a historic second treble, after which he was awarded a fifth \
+Ballon d'Or in 2015. Messi assumed captaincy of Barcelona in 2018, and won a record \
+sixth Ballon d'Or in 2019. Out of contract, he signed for French club Paris Saint-Germain\
+in August 2021, spending two seasons at the club and winning Ligue 1 twice. Messi \
+joined American club Inter Miami in July 2023, winning the Leagues Cup in August of that year.
+"""
+
+answer_highlighted_context = highlight_answer(context=context, answer='Inter Miami')
+prompt = prepare_instruction(answer_highlighted_context)
+```
+
+This will be the final prompt:
+```
+Generate a question whose answer is highlighted by <h> from the context delimited by the triple backticks
+context:
+```During the 2011–12 season, he set the La Liga and European records\
+for most goals scored in a single season, while establishing himself as Barcelona's\
+all-time top scorer. The following two seasons, Messi finished second for the Ballon\
+d'Or behind Cristiano Ronaldo (his perceived career rival), before regaining his best\
+form during the 2014–15 campaign, becoming the all-time top scorer in La Liga and \
+leading Barcelona to a historic second treble, after which he was awarded a fifth \
+Ballon d'Or in 2015. Messi assumed captaincy of Barcelona in 2018, and won a record\
+ sixth Ballon d'Or in 2019. Out of contract, he signed for French club Paris Saint-Germain\
+in August 2021, spending two seasons at the club and winning Ligue 1 twice. Messi \
+joined American club  <h> Inter Miami <h> in July 2023, winning the Leagues Cup in August of that year.```
+```
+
+3. Use the loaded `pipeline` to generate questions their answer is `Inter Miami`:
+
+```Python
+outputs = pipe(prompt, num_return_sequences=3, num_beams=5, num_beam_groups=5, diversity_penalty=1.0)
+for output in outputs:
+    print(output['generated_text'])
+```
+
+Result:
+```
+1. What club did Messi join in the 2023 season?
+2. What was Messi's name of the club that won the Leagues Cup on July 20?
+3. What club did Messi join in the Leagues Cup in July 2023?
+```
+
 
 ## Training and evaluation data
 
@@ -62,4 +185,4 @@ The following hyperparameters were used during training:
 - Transformers 4.38.1
 - Pytorch 2.1.2
 - Datasets 2.13.1
-- Tokenizers 0.15.2
+- Tokenizers 0.15.2