evrz hackathon

Bot de revue télégramme

Un bot de télégramme Python qui traite des fichiers d'archives, extrait les structures de projet, le code d'analyse et génère un rapport d'examen basé sur la base de connaissances fournie.

Caractéristiques

• Prise en charge du fichier: accepte divers formats de fichiers.
• Support d'archives: accepte les formats d'archives RAR, ZIP et 7Z.
• Aperçu de la révision: envoie un aperçu paginé des résultats de la revue.
• Téléchargement de la révision: fournit un bouton pour télécharger le rapport d'examen complet en tant que fichier PDF.
• Rag: utilise un chiffon pour fournir un contexte pour le modèle.
• Small LLM: utilise le modèle Mistral-NEMO 12B pour fournir une revue complète nécessitant moins de 20 Go de VRAM.

Installation

Condition préalable

• Python 3.11+
• Poésie pour la gestion des dépendances. Installer à partir du site officiel de la poésie
• Minio Server avec enregistrement DNS pour les URL pré-attribuées (les informations d'identification seront fournies séparément)
• Dépendances du système :
  • Pour l'extraction RAR, assurez-vous que unrar est installé sur votre système:
    • Ubuntu: sudo apt-get install unrar
    • macOS (avec homebrew): brew install unrar
    • Windows: n'est pas pris en charge en raison du manque de bibliothèques prises en charge.

Note importante pour le développement local

Si l'exécution du bot localement (Docker extérieur), vous devrez gérer séparément l'installation de Pytorch:

• Soit l'exécution: pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• Ou décommenter la dépendance torch dans pyproject.toml et essayer de l'installer, mais il peut échouer .

Installation

1. Cloner le référentiel

   git clone https://github.com/isofinly/telegram_review_bot.git
   cd telegram_review_bot

2. Configurer les variables d'environnement Créez un fichier .env avec les variables requises suivantes:

    BOT_TOKEN=your_telegram_bot_token
   MINIO_ENDPOINT=your_minio_endpoint
   MINIO_ACCESS_KEY=your_minio_access_key
   MINIO_SECRET_KEY=your_minio_secret_key
   MINIO_SECURE=true_or_false
   MODEL_API_KEY=your_model_api_key
   

   Remarque: les informations d'identification MINIO seront fournies via Manager et Cloud Drive Document.

3. Choisissez votre méthode d'installation

   Docker (recommandé) :

   docker-compose up -d

   Cela démarrera les conteneurs Bot et Minio Server.

   Installation locale :

   poetry install
   poetry run telegram-review-bot

Usage

1. Démarrer le bot

   Ouvrez télégramme et recherchez votre bot. Commencez une conversation en envoyant /start .

2. 2.1 Envoyer un fichier

   Envoyez un fichier au bot.

   2.2 Envoyez une archive

   Ou vous pouvez envoyer un fichier d'archive (RAR, ZIP, 7Z) au bot.

3. Recevoir des sorties

   • Aperçu de la révision: le bot répondra avec un aperçu paginé des résultats de la revue.
   • Téléchargement de la révision: Utilisez le bouton fourni pour télécharger le rapport d'examen complet en tant que fichier PDF.

Examiner le pipeline

1. RAG : Créez une base de données vectorielle à partir de la base de connaissances pour aligner des morceaux de code avec des exemples de révision pertinents.
2. Revoir :
   • Structure du projet d'analyse
   • Analyser la structure des fichiers individuels.
   • Divisez les fichiers en morceaux gérables.
   • Utilisez un chiffon pour générer des invites et des informations contextuelles pour le modèle.
   • Générer et formater l'examen

Structure de packages

• src/bot - Code de bot télégramme.
• src/review - Code Review Logic.
• • src/review/parsers - CODE CHANGING LOGIC

Contributif

Les contributions sont les bienvenues! Veuillez ouvrir un problème ou soumettre une demande de traction pour toute amélioration ou correction de bogues.

Licence

Mit