Update README.md

README.md

@@ -88,4 +88,119 @@ model-index:
     - type: acc
       value: 22.27
       name: accuracy
----
+---
+
+<img src="https://path.to/your/legml-image.png" alt="LegML-v0.1" width="500"/>
+
+# LegML-v0.1
+
+LegML-v0.1 est un modèle de langage de grande taille (LLM) en français, doté de multiples capacités couvrant divers domaines tels que la programmation, les mathématiques et bien d'autres. Ce modèle est une version améliorée d'un LLM basé sur Qwen, spécialement adapté pour le français. Il a été entraîné sur un ensemble de données français soigneusement nettoyé et annoté pour exécuter des instructions en français de manière précise et organisée.
+
+L'entraînement du modèle a été intensif, effectué sur 4 GPU A100 pendant deux jours, en utilisant ce jeu de données spécialisé pour optimiser ses performances.
+
+## Détails du Modèle
+
+- **Modèle de Base** : LLM Qwen-2.5 de 14 milliards de paramètres
+- **Jeu de Données d'Entraînement** : Ensemble de données français annoté et nettoyé
+- **Méthode d'Entraînement** : Affinage complet et exhaustif
+
+## Exemples d'Utilisation
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+device = "cuda"  # l'appareil sur lequel charger le modèle
+
+model_name = "VotreNomUtilisateur/LegML-v0.1"
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype="auto",
+    device_map="auto"
+)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+prompt = "Comment afficher 'Bonjour le monde' en Python ?"
+messages = [
+    {
+        "role": "system",
+        "content": "Vous êtes une intelligence artificielle assistante créée par LegAI, conçue pour suivre les instructions données et fournir les meilleures réponses possibles."
+    },
+    {
+        "role": "user",
+        "content": prompt
+    }
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(device)
+
+generated_ids = model.generate(
+    model_inputs.input_ids,
+    temperature=0.3,
+    top_k=50,
+    top_p=0.9,
+    max_new_tokens=512,
+    repetition_penalty=1.0,
+)
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+print(response)
+```
+
+## Exemples de Générations
+
+### Exemple 1
+
+**Invite :**
+
+```
+Comment les institutions financières en France gèrent-elles les risques de sécurité des données associés à l'intelligence artificielle ? Pouvez-vous donner trois exemples ?
+```
+
+**Réponse :**
+
+Les institutions financières en France gèrent les risques de sécurité des données liés à l'intelligence artificielle (IA) par plusieurs approches :
+
+1. **Implémentation de Protocoles de Chiffrement Avancés** : Elles utilisent des méthodes de chiffrement robustes comme AES ou RSA pour protéger les informations sensibles des clients contre tout accès non autorisé.
+
+2. **Déploiement de Systèmes de Détection d'Anomalies Basés sur l'IA** : Ces systèmes surveillent les transactions en temps réel pour identifier des comportements inhabituels, aidant ainsi à prévenir la fraude et les cyberattaques.
+
+3. **Conformité Réglementaire et Formation du Personnel** : Les institutions s'assurent de respecter les réglementations telles que le RGPD et investissent dans la formation continue de leur personnel sur les meilleures pratiques en matière de sécurité des données.
+
+### Exemple 2
+
+**Invite :**
+
+```
+Comment afficher "Bonjour le monde" en Python ?
+```
+
+**Réponse :**
+
+Pour afficher "Bonjour le monde" en Python, vous pouvez utiliser la fonction \`print()\`. Voici comment procéder :
+
+```python
+print("Bonjour le monde")
+```
+
+En exécutant ce code, le texte "Bonjour le monde" sera affiché à l'écran. La fonction \`print()\` est utilisée pour afficher des messages ou des variables en sortie.
+
+## Résultats de l'Évaluation
+
+Les performances de LegML-v0.1 ont été évaluées sur plusieurs benchmarks en français. Voici les résultats obtenus :
+
+| Benchmark          | Métrique               | Valeur (%) |
+|--------------------|------------------------|-----------:|
+| **BBH-fr**         | Précision normalisée   |     37.17% |
+| **GPQA-fr**        | Précision normalisée   |     16.49% |
+| **IFEval-fr**      | Précision stricte      |     14.68% |
+| **MUSR-fr**        | Précision normalisée   |      9.93% |
+| **MATH-lvl5-fr**   | Correspondance exacte  |     22.27% |
+| **MMMLU-fr**       | Précision              |     68.31% |
+
+Ces résultats reflètent les capacités du modèle sur une variété de tâches complexes en français, tout en soulignant les domaines où des améliorations sont possibles.