local-assistant

llm agent for local assistant with vocal ( STT not include )

Table des Matières

• Introduction
• Installation
• Utilisation
• Contribuer
• Licence
• Auteurs
• Remerciements

Introduction

Dans un monde où les assistants vocaux dominants comme Alexa, Google Assistant et Siri semblent souvent déconnectés des besoins quotidiens et des scénarios uniques que nous envisageons, il est temps de réimaginer ce qu'un assistant vocal peut être. Ce projet est né d'une vision : créer un assistant vocal qui soit véritablement local, un outil qui s'intègre harmonieusement avec nos autres projets, qu'il s'agisse de reconnaissance vocale, de synthèse vocale, ou de bien d'autres innovations.

Plutôt que de chercher à surpasser les géants, l'objectif est de faire les choses correctement. Car, comme le dit le proverbe, "le mieux est l'ennemi du bien". Cet assistant est conçu pour être un allié fidèle, capable d'exécuter des appels de fonctions en utilisant les ressources locales de l'utilisateur, tout en respectant la simplicité et l'efficacité. C'est une invitation à redécouvrir la puissance de la technologie locale, façonnée par et pour ses utilisateurs.

Installation

Pour installer et utiliser ce projet de manière optimale, il est recommandé d'utiliser un environnement virtuel. Cela permet de gérer les dépendances de manière isolée et d'éviter les conflits avec d'autres projets.

Installation de pyenv

1. Installer les dépendances nécessaires :

   sudo apt update
   sudo apt install -y make build-essential libssl-dev zlib1g-dev \
   libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \
   libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev liblzma-dev \
   python-openssl git

2. Installer pyenv :

   curl https://pyenv.run | bash

3. Ajouter pyenv à votre shell : Ajoutez les lignes suivantes à votre fichier ~/.bashrc ou ~/.zshrc :

   export PATH="$HOME/.pyenv/bin:$PATH"
   eval "$(pyenv init --path)"
   eval "$(pyenv virtualenv-init -)"

4. Redémarrer votre terminal ou exécuter :

   source ~/.bashrc

Installation de Python 3.10.16 avec pyenv

1. Installer Python 3.10.16 :

   pyenv install 3.10.16

2. Définir la version globale de Python :

   pyenv global 3.10.16

Création d'un environnement virtuel avec virtualenv

1. Installer virtualenv :

   pip install virtualenv

2. Créer un environnement virtuel :

   virtualenv venv

3. Activer l'environnement virtuel :

   source venv/bin/activate

4. Installer les dépendances du projet : Avec l'environnement virtuel activé, installez les dépendances :

   pip install -r requirements.txt

Utilisation

1. Lancer l'assistant local :

   • Assurez-vous que votre environnement virtuel est activé.
   • Exécutez la commande suivante pour démarrer l'assistant avec un prompt spécifique :

     python local-assistant/main.py --prompt "Quel heure est-il ?"

2. Changer le modèle utilisé :

   • Vous pouvez spécifier un modèle différent en utilisant l'option --model :

     python local-assistant/main.py --prompt "Quel est le temps aujourd'hui ?" --model "llama3.2:3b"

3. Utiliser une URL de serveur Ollama différente :

   • Si votre serveur Ollama est hébergé à une URL différente, utilisez l'option --ollama-base-url :

     python local-assistant/main.py --prompt "Démarre le serveur" --ollama-base-url "http://192.168.1.100:11434"

4. Décharger le modèle après utilisation :

   • Pour libérer des ressources, vous pouvez décharger le modèle après son utilisation avec l'option --unload :

     python local-assistant/main.py --prompt "Arrête le service" --unload

5. Afficher l'aide :

   • Pour voir toutes les options disponibles, utilisez l'option --help :

     python local-assistant/main.py --help

Contribuer

Nous accueillons avec plaisir les contributions de la communauté ! Voici comment vous pouvez contribuer :

1. Signaler des bugs : Si vous trouvez un bug, veuillez ouvrir une issue sur le dépôt GitHub avec des détails sur le problème et comment le reproduire.

2. Proposer des améliorations : Si vous avez des idées pour améliorer le projet, n'hésitez pas à ouvrir une issue pour en discuter. Nous sommes toujours ouverts aux nouvelles idées !

3. Soumettre des pull requests :

   • Forkez le dépôt : Créez une copie de ce dépôt sur votre compte GitHub.
   • Clonez votre fork : Clonez votre fork sur votre machine locale.

     git clone https://github.com/votre-utilisateur/local-assistant.git

   • Créez une branche : Créez une nouvelle branche pour votre fonctionnalité ou correction de bug.

     git checkout -b ma-nouvelle-fonctionnalite

   • Effectuez vos modifications : Apportez vos modifications et assurez-vous que le code fonctionne correctement.
   • Testez vos modifications : Exécutez les tests pour vous assurer que tout fonctionne comme prévu.
   • Commitez vos modifications : Commitez vos modifications avec un message clair et descriptif.

     git commit -m "Ajout d'une nouvelle fonctionnalité"

   • Poussez votre branche : Poussez votre branche sur GitHub.

     git push origin ma-nouvelle-fonctionnalite

   • Ouvrez une pull request : Allez sur le dépôt original et ouvrez une pull request pour que nous puissions examiner vos modifications.

4. Respectez le code de conduite : Assurez-vous de respecter notre code de conduite lors de vos interactions avec la communauté.

5. Documentation : Aidez à améliorer la documentation en ajoutant des exemples, en clarifiant des sections ou en corrigeant des erreurs.

En suivant ces étapes, vous pouvez contribuer efficacement au projet et aider à son amélioration continue. Si vous avez des questions, n'hésitez pas à nous contacter via les issues sur GitHub.

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

Auteurs

Ce projet a été créé par @0x07cb. Bien que je sois actuellement le seul auteur, je suis ouvert à de futures collaborations et contributions de la communauté.

Remerciements

Remerciements à ceux qui ont aidé au développement du projet.

Si vous souhaitez soutenir ce projet, vous pouvez m'offrir un café.