diff --git a/readme.md b/readme.md index 721be3f154dc680ad59a9ba6f69dd92052b4a9f8..4c7fcf45826010c199a62a2afefeaec394a0e717 100644 --- a/readme.md +++ b/readme.md @@ -1,36 +1,40 @@ -# Prérequis : +# Guide d'installation : +Pour installer le chatbot, il faut commencer par télécharger le répertoire disponible sur gitlab et le +dézipper dans un dossier local. Python doit être installé avec une version 3.6 ou ultérieure. +Ensuite, suivre les étapes suivantes : -Afin de pouvoir executer le code il faut créer un environnement virtuel python : +— Se placer dans le dossier de travail avec un terminal. -``` -python3 -m venv venv -``` +— Créer un environnement virtuel (non nécessaire mais conseillé) avec python. Cela s’effectue +avec une commande du type : +``` python -m venv /path/to/new/virtual/environment ``` -naviguer dans le virtual env : +Pour faire simple, on va créer l’environnement virtuel dans le même dossier. Lancer la commande : +``` python -m venv myenv ```. -``` -source venv/bin/activate -``` +— Lancer l’environnement virtuel avec la commande correspondant au terminal utilisé. Dans le +cadre de notre exemple, remplacer « <venv> » par « myenv ». Par exemple, avec l’invite de com- +mande windows, la commande sera « myenv\scripts\activate.bat » + +— Installer les librairies nécessaires qui sont présentes dans « requirements.txt » en lançant la +commande : +``` pip install -r requirements.txt ``` + +— Lancer le fichier python download_nltk_ressources.py pour télécharger les ressoruces néces- +saires de nltk : +``` python download_nltk_ressources.py ``` -Ensuite installer les bibliothèques nécessaires qui se trouvent dans le fichier `requirements.txt`: -``` -pip install requirements.txt -``` # Architecture du code Le code créée a pour objectif de reproduire cette architecture :  -## Lancement de l'application : +# Lancement de l'application : -Pour lancer l'application il faut soit executer le script `chatbot_complet.py` qui est en fait un algo de retrieving de +Pour lancer l application il faut soit executer le script `chatbot_complet.py` qui est en fait un algo de retrieving de documents, il ne contient pas la partie LLM. Pour la partie LLM il faut lancer le script `chatbot_with_summarizer.py` qui contient à la fois le modèle de Q/A et -l'affichage des documents qui sont pertinents pour la question posée. - -Dans le script `chatbot_complet.py`, on trouve à la fois le script de la réponse mais aussi celui de l'interface. Ce code peut être utilisé sans problème en loca cependant il doit etre adapté pour une mise en production en utilisant le code de réponse. - -Le règlement de la scolarité ou a déja été effectué le préprocess se trouve dans le fichier `reglementdescolarite-ingegeneraliste2324-1.docx.txt`. \ No newline at end of file +l affichage des documents qui sont pertinents pour la question posée. \ No newline at end of file