Create README.md

README.md

@@ -0,0 +1,26 @@
+'''Guillaume Tell''' is a French LLM based on Mistral Open-Hermes 2.5 optimized for Retrieval-Augmented Generation with source tracability and explainability.
+
+## Purpose:
+
+Guillaume Tell aims to enhance the verifiability of text generation based on French administrative sources. Given a question and a selection of five chunks/sources it will generate a sourced answer, with a special parameters for quotations.
+
+For instance:
+
+> Question:
+> 
+> Sources:
+> * b23cf4beca241df1_0 : Attestation et certificat d'assurance. Réception des documents. Cas Si vous souscrivez un nouveau contrat…
+> * a8f39f4e74aeb9ec_0 : Refus d'assurance auto : que faire ?…
+> * 0cc40059e0b26584_0 : Attestation et certificat d'assurance. Perte ou vol des documents.
+> * 112693208e5e6902_0 : Que faire en cas de litige lié à la location d'un logement ?…
+> * 37c413dba413096a_0 : Que faire en cas de litige lié à la location d'un logement ?…
+> 
+> Result:
+> Pour adresser une lettre recommandée avec accusé de réception à votre assureur, plusieurs étapes sont à suivre. Tout d'abord, il est nécessaire de rédiger un courrier décrivant les faits le plus précisément possible<ref text="Le courrier doit décrire les faits le plus précisément possible.">[112693208e5e6902_0]</ref>. Il est également recommandé d'y joindre des documents pour appuyer votre propos<ref text="Vous devez y joindre des documents pour appuyer votre propos (textes de loi, règlement, factures, photos...).">[37c413dba413096a_0]</ref>.
+> Une fois le courrier rédigé, il faut l'envoyer par courrier en recommandé avec accusé de réception<ref text="par courrier en recommandé avec accusé de réception.">[b23cf4beca241df1_0]</ref>. Si votre assureur ne vous répond pas dans un délai de 15 jours, vous pouvez lui adresser une mise en demeure<ref text="Si votre assureur ne vous a pas envoyé ces pièces dans ce délai, vous pouvez lui adresser une mise en demeure.">[0cc40059e0b26584_0]</ref>.
+
+## Use:
+
+Like Mistral Open-Hermes 2.5, Guillaume Tell syntax is based on chatml. It requires a special system prompt, as well as a predefined syntax to append the sources to the question.
+
+<|im_start|>system\nTu es Albert, le chatbot des Maisons France Service qui donne des réponses sourcées.<|im_end|>\n<|im_start|>user