Update README.md

README.md

@@ -9,4 +9,64 @@ base_model:
 pipeline_tag: text2text-generation
 library_name: transformers
 ---
-Alpha merged version of [eltorio/Llama-3.2-3B-appreciation](https://huggingface.co/eltorio/Llama-3.2-3B-appreciation)
+# Llama-3.2-3B-appreciation-full a merged version of Llama-3.2-3B-appreciation
+Alpha merged version of [eltorio/Llama-3.2-3B-appreciation](https://huggingface.co/eltorio/Llama-3.2-3B-appreciation)  
+See original model for documentation…  
+
+Sample notebook:  
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/#fileId=https://huggingface.co/eltorio/Llama-3.2-3B-appreciation-full/blob/main/llama-3-2-3b-appreciation-full-inference-test.ipynb)
+
+Sample inference code:  
+```python
+# -*- coding: utf-8 -*-
+"""
+Llama-3.2-3B-appreciation-full-inference-test.py
+
+This script loads the model, generates a mutliturn conversation and finally query the model.
+The model is available on Hugging Face and is based on the Llama 3.2 3B-instruct model.
+model_id: "eltorio/Llama-3.2-3B-appreciation-full"
+
+Author: Ronan Le Meillat
+License: AGPL-3.0
+"""
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+tokenizer = AutoTokenizer.from_pretrained("eltorio/Llama-3.2-3B-appreciation-full")
+model = AutoModelForCausalLM.from_pretrained("eltorio/Llama-3.2-3B-appreciation-full")
+
+# Define a function to infer a evaluation from the incoming parameters
+def infere(trimestre: str, moyenne_1: float,moyenne_2: float,moyenne_3: float, comportement: float, participation: float, travail: float) -> str:
+
+    if trimestre == "1":
+        trimestre_full = "premier trimestre"
+        user_question = f"Veuillez rédiger une appréciation en moins de 40 mots pour le {trimestre_full} pour cet élève qui a eu {moyenne_1} de moyenne, j'ai évalué son comportement à {comportement}/10, sa participation à {participation}/10 et son travail à {travail}/10. Les notes ne doivent pas apparaître dans l'appréciation."
+    elif trimestre == "2":
+        trimestre_full = "deuxième trimestre"
+        user_question = f"Veuillez rédiger une appréciation en moins de 40 mots pour le {trimestre_full} pour cet élève qui a eu {moyenne_2} de moyenne ce trimestre et {moyenne_1} au premier trimestre, j'ai évalué son comportement à {comportement}/10, sa participation à {participation}/10 et son travail à {travail}/10. Les notes ne doivent pas apparaître dans l'appréciation."
+    elif trimestre == "3":
+        trimestre_full = "troisième trimestre"
+        user_question= f"Veuillez rédiger une appréciation en moins de 40 mots pour le {trimestre_full} pour cet élève qui a eu {moyenne_3} de moyenne ce trimestre, {moyenne_2} au deuxième trimestre et {moyenne_1} au premier trimestre, j'ai évalué son comportement à {comportement}/10, sa participation à {participation}/10 et son travail à {travail}/10. Les notes ne doivent pas apparaître dans l'appréciation."
+    messages = [
+        {
+            "role": "system",
+            "content": "Vous êtes une IA assistant les enseignants d'histoire-géographie en rédigeant à leur place une appréciation personnalisée pour leur élève en fonction de ses performances. Votre appreciation doit être en français, et doit aider l'élève à comprendre ses points forts et les axes d'amélioration. Votre appréciation doit comporter de 1 à 40 mots. Votre appréciation ne doit jamais comporter la valeur de la note. Votre appréciation doit utiliser le style impersonnel.Attention l'élément le plus important de votre analyse doit rester la moyenne du trimestre"},
+        {
+            "role": "user",
+            "content": user_question},
+    ]
+    return messages
+
+# Generate the conversation
+messages = infere("1", 3, float('nan'), float('nan'), 10, 10, 10)
+
+# Generate the output
+outputs = model.generate(input_ids = inputs, 
+                                        max_new_tokens = 90, 
+                                        use_cache = True,
+                                        temperature = 1.5,
+                                        min_p = 0.1,
+                                        pad_token_id=tokenizer.eos_token_id,)
+decoded_sequences = tokenizer.batch_decode(outputs[:, inputs.shape[1]:],skip_special_tokens=True)[0]
+
+print(decoded_sequences)
+```