Update README.md

README.md

@@ -1,18 +1,80 @@
 ---
 license: apache-2.0
+language:
+  - fr
 tags:
-- generated_from_trainer
+  - flan-t5
+  - qa
+  - lfqa
+  - information retrieval
+datasets:
+  - vblagoje/lfqa
+metrics:
+  - rouge
 model-index:
-- name: flan-t5-large-lfqa-fr-v3
-  results: []
+  - name: flan-t5-large-lfqa-fr-v3
+    results: []
+widget:
+  - text: >-
+      Please answer to the following question : Comment fonctionne un modèle de langue ? Que signifi un modèle
+      de question réponse générative ?  context :   Les modèles de langage basés
+      sur le deep learning sont des modèles dapprentissage automatique qui
+      utilisent des techniques dapprentissage profond pour effectuer des tâches
+      de langage.En traitement automatique des langues, un modèle de langage est
+      un modèle statistique qui modélise la distribution de séquences de mots,
+      plus généralement de séquences de symboles discrets (lettres, phonèmes,
+      mots), dans une langue naturelle. Un modèle de langage peut par exemple
+      prédire le mot suivant une séquence de mots1.BERT, GPT-3 et Bloom sont des
+      modèles de langage.Les modèles de Question Réponse (QA) permette 
+      d'automatiser la réponse aux questions fréquemment posées en utilisant une
+      base de connaissances (documents) comme contexte. Les réponses aux
+      questions des clients peuvent être tirées de ces documents.Il existe
+      différentes variantes de modèle de question réponse : question réponse
+      extractive : le modèle extrait la réponse d'un contexte. Le contexte ici
+      peut être un texte fourni, un tableau ou même du HTML ! Ceci est
+      généralement résolu avec des modèles de type BERT. question réponse
+      générative ouverte : le modèle génère du texte libre directement en
+      fonction du contexte. question réponse générative fermée : dans ce cas,
+      aucun contexte n'est fourni. La réponse est entièrement générée par un
+      modèle.Les modèles de langage basés sur le deep learning sont des modèles
+      dapprentissage automatique qui utilisent des techniques dapprentissage
+      profond pour effectuer des tâches de langage.En traitement automatique des
+      langues, un modèle de langage est un modèle statistique qui modélise la
+      distribution de séquences de mots, plus généralement de séquences de
+      symboles discrets (lettres, phonèmes, mots), dans une langue naturelle. Un
+      modèle de langage peut par exemple prédire le mot suivant une séquence de
+      mots.Les modèles de Question Réponse (QA) permette  d'automatiser la
+      réponse aux questions fréquemment posées en utilisant une base de
+      connaissances (documents) comme contexte. Les réponses aux questions des
+      clients peuvent être tirées de ces documents.Il existe différentes
+      variantes de modèle de question réponse : question réponse extractive : le
+      modèle extrait la réponse d'un contexte. Le contexte ici peut être un
+      texte fourni, un tableau ou même du HTML ! Ceci est généralement résolu
+      avec des modèles de type BERT. question réponse générative ouverte : le
+      modèle génère du texte libre directement en fonction du contexte. question
+      réponse générative fermée : dans ce cas, aucun contexte n'est fourni. La
+      réponse est entièrement générée par un modèle.  
+    example_title: Les modèles de langage
+inference:
+  parameters:
+    max_length: 512
+    num_return_sequences: 1
+    min_length: 80
+    no_repeat_ngram_size: 4
+    do_sample: false
+    num_beams: 8
+    early_stopping: true
 ---
 
 <!-- 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. -->
 
-# flan-t5-large-lfqa-fr-v3
+# flan-t5-large-lfqa-fr
+
+This model is a fine-tuned version of [google/flan-t5-large](https://huggingface.co/google/flan-t5-large) on some examples (50000) of the vblagoje/lfqa dataset translated automatically to French using Helsinki-NLP/opus-mt-en-fr model.
+
+Therefore the main task this model can perform is abstractive question answering given certain context paragraphs which can be used to answer that question. 
 
-This model is a fine-tuned version of [google/flan-t5-large](https://huggingface.co/google/flan-t5-large) on an unknown dataset.
 
 ## Model description
 
@@ -44,10 +106,40 @@ The following hyperparameters were used during training:
 ### Training results
 
 
+### Usage
+
+```python
+from transformers import AutoTokenizer, AutoModel, AutoModelForSeq2SeqLM
+
+model_name = "hmahmoud/flan-t5-large-lfqa-fr-v3"
+
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForSeq2SeqLM.from_pretrained(model_name)
+
+query = "Comment fonctionne un modèle de langue ? Que signifi un modèle de question réponse générative ?"
+
+document = "Les modèles de langage basés sur le deep learning sont des modèles dapprentissage automatique qui utilisent des techniques dapprentissage profond pour effectuer des tâches de langage.En traitement automatique des langues, un modèle de langage est un modèle statistique qui modélise la distribution de séquences de mots, plus généralement de séquences de symboles discrets (lettres, phonèmes, mots), dans une langue naturelle. Un modèle de langage peut par exemple prédire le mot suivant une séquence de mots1.BERT, GPT-3 et Bloom sont des modèles de langage.Les modèles de Question Réponse (QA) permette  d'automatiser la réponse aux questions fréquemment posées en utilisant une base de connaissances (documents) comme contexte. Les réponses aux questions des clients peuvent être tirées de ces documents.Il existe différentes variantes de modèle de question réponse : question réponse extractive : le modèle extrait la réponse d'un contexte. Le contexte ici peut être un texte fourni, un tableau ou même du HTML ! Ceci est généralement résolu avec des modèles de type BERT. question réponse générative ouverte : le modèle génère du texte libre directement en fonction du contexte. question réponse générative fermée : dans ce cas, aucun contexte n'est fourni. La réponse est entièrement générée par un modèle.Les modèles de langage basés sur le deep learning sont des modèles dapprentissage automatique qui utilisent des techniques dapprentissage profond pour effectuer des tâches de langage.En traitement automatique des langues, un modèle de langage est un modèle statistique qui modélise la distribution de séquences de mots, plus généralement de séquences de symboles discrets (lettres, phonèmes, mots), dans une langue naturelle. Un modèle de langage peut par exemple prédire le mot suivant une séquence de mots.Les modèles de Question Réponse (QA) permette  d'automatiser la réponse aux questions fréquemment posées en utilisant une base de connaissances (documents) comme contexte. Les réponses aux questions des clients peuvent être tirées de ces documents.Il existe différentes variantes de modèle de question réponse : question réponse extractive : le modèle extrait la réponse d'un contexte. Le contexte ici peut être un texte fourni, un tableau ou même du HTML ! Ceci est généralement résolu avec des modèles de type BERT. question réponse générative ouverte : le modèle génère du texte libre directement en fonction du contexte. question réponse générative fermée : dans ce cas, aucun contexte n'est fourni. La réponse est entièrement générée par un modèle."
+
+query_and_docs = "Please answer to the following question : {} context: {}".format(query, document)
+
+model_input = tokenizer(query_and_docs, truncation=True, padding=True, return_tensors="pt")
+
+generated_answers_encoded = model.generate(input_ids=model_input["input_ids"].to(device),
+                                           attention_mask=model_input["attention_mask"].to(device),
+                                           min_length=80,
+                                           max_length=512,
+                                           do_sample=False, 
+                                           early_stopping=True,
+                                           num_beams=8,
+                                           temperature=None,
+                                           top_k=None,
+                                           top_p=None,    
+                                           eos_token_id=tokenizer.eos_token_id,
+                                           no_repeat_ngram_size=4,
+                                           num_return_sequences=1)
+tokenizer.batch_decode(generated_answers_encoded, skip_special_tokens=True,clean_up_tokenization_spaces=True)
+```
+
+
 
-### Framework versions
 
-- Transformers 4.28.1
-- Pytorch 1.11.0
-- Datasets 2.1.0
-- Tokenizers 0.12.1