evrz hackathon

Telegram Review Bot

Ein Python -Telegramm -Bot, der Archivdateien verarbeitet, Projektstrukturen extrahiert, Code annimmt und einen Überprüfungsbericht basierend auf der bereitgestellten Wissensbasis generiert.

Merkmale

• Dateiunterstützung: Akzeptiert verschiedene Dateiformate.
• Archivunterstützung: Akzeptiert RAR-, Reißverschluss- und 7z -Archivformate.
• Überprüfung Vorschau: Sendet eine paginierte Vorschau der Überprüfungsergebnisse.
• Überprüfung herunterladen: Bietet eine Schaltfläche zum Herunterladen des vollständigen Bewertungsberichts als PDF -Datei.
• RAG: Verwendet Rag, um den Kontext für das Modell bereitzustellen.
• Small LLM: Verwendet das 12B-Modell des Mistral-NEMO-12B für eine umfassende Überprüfung, die weniger als 20 GB VRAM erfordert.

Aufstellen

Voraussetzungen

• Python 3.11+
• Poesie für das Abhängigkeitsmanagement. Installieren Sie von der offiziellen Website der Poesie
• Minio-Server mit DNS-Datensatz für vorab zugewiesene URLs (Anmeldeinformationen werden separat bereitgestellt)
• Systemabhängigkeiten :
  • Stellen Sie für die RAR -Extraktion sicher, dass unrar in Ihrem System installiert ist:
    • Ubuntu: sudo apt-get install unrar
    • macOS (mit Homebrew): brew install unrar
    • Windows: wird aufgrund des Mangels an unterstützten Bibliotheken nicht unterstützt.

Wichtiger Hinweis für die lokale Entwicklung

Wenn Sie den Bot lokal ausführen (außerhalb des Dockers), müssen Sie die Pytorch -Installation separat verarbeiten:

• Entweder Auslauf: pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• Oder wenden Sie sich an die torch in pyproject.toml und versuchen Sie, sie zu installieren, aber es kann möglicherweise fehlschlagen .

Installation

1. Klonen Sie das Repository

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

2. Konfigurieren von Umgebungsvariablen Erstellen Sie eine .env -Datei mit den folgenden erforderlichen Variablen:

    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
   

   Hinweis: Minio -Anmeldeinformationen werden über Manager und Cloud -Laufwerksdokument bereitgestellt.

3. Wählen Sie Ihre Installationsmethode

   Docker (empfohlen) :

   docker-compose up -d

   Dadurch wird sowohl die Bot- als auch die Minio -Server -Container gestartet.

   Lokale Installation :

   poetry install
   poetry run telegram-review-bot

Verwendung

1. Starten Sie den Bot

   Öffnen Sie das Telegramm und suchen Sie nach Ihrem Bot. Beginnen Sie ein Gespräch, indem Sie senden /start .

2. 2.1 eine Datei senden

   Senden Sie eine Datei an den Bot.

   2.2 Senden Sie ein Archiv

   Oder Sie können eine Archivdatei (RAR, Reißverschluss, 7z) an den Bot senden.

3. Ausgänge empfangen

   • Überprüfung Vorschau: Der Bot antwortet mit einer pagierten Vorschau der Überprüfungsergebnisse.
   • Überprüfen Sie Download: Verwenden Sie die angebotene Schaltfläche zum Herunterladen des vollständigen Bewertungsberichts als PDF -Datei.

Überprüfungspipeline

1. RAG : Erstellen Sie eine Vektordatenbank aus der Wissensbasis, um Code -Stücke mit relevanten Überprüfungsbeispielen auszurichten.
2. Rezension :
   • Projektstruktur analysieren
   • Analysieren Sie die Struktur einzelner Dateien.
   • Teilen Sie Dateien in überschaubare Stücke ein.
   • Verwenden Sie RAG, um Eingabeaufforderungen und Kontextinformationen für das Modell zu generieren.
   • Generieren Sie die Bewertung und formatieren Sie sie

Packungsstruktur

• src/bot - Telegramm -Bot -Code.
• src/review - Code Review Logic.
• • src/review/parsers - Code -Chunking -Logik

Beitragen

Beiträge sind willkommen! Bitte öffnen Sie ein Problem oder senden Sie eine Pull -Anfrage für Verbesserungen oder Fehlerbehebungen.

Lizenz

MIT