evrz hackathon

電報評論機器人

一個處理存檔文件，提取項目結構，解析代碼並根據提供的知識庫生成審核報告的Python Telegram機器人。

特徵

• 文件支持：接受各種文件格式。
• 檔案支持：接受RAR，ZIP和7Z檔案格式。
• 評論預覽：發送評論結果的分頁預覽。
• 評論下載：提供一個按鈕，將完整的審核報告作為PDF文件下載。
• 抹布：使用抹佈為模型提供上下文。
• 小型LLM：使用Mistral-Nemo 12B模型進行全面的審查，需要少於20GB的VRAM。

設定

先決條件

• Python 3.11+
• 依賴管理的詩歌。從詩歌的官方網站安裝
• 具有預先分配URL的DNS記錄的Minio服務器（將單獨提供憑據）
• 系統依賴性：
  • 對於RAR提取，請確保您的系統上安裝了unrar ：
    • ubuntu： sudo apt-get install unrar
    • MacOS（與自製）： brew install unrar
    • Windows：由於缺乏支持的庫而不受支持。

重要說明本地發展

如果在本地運行機器人（外部碼頭），則需要單獨處理Pytorch安裝：

• 運行： pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• 或在pyproject.toml中取消割torch依賴性並嘗試安裝它，但可能會失敗。

安裝

1. 克隆存儲庫

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

2. 配置環境變量創建一個.env文件，其中具有以下必需變量：

    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
   

   注意：將通過管理器和雲驅動文檔提供Minio憑據。

3. 選擇您的安裝方法

   Docker（推薦） ：

   docker-compose up -d

   這將啟動機器人和Minio服務器容器。

   本地安裝：

   poetry install
   poetry run telegram-review-bot

用法

1. 啟動機器人

   打開電報並蒐索您的機器人。通過發送/start開始對話。

2. 2.1發送文件

   將文件發送到機器人。

   2.2發送檔案

   或者，您可以將存檔文件（RAR，ZIP，7Z）發送到機器人。

3. 接收輸出

   • 評論預覽：機器人將以分頁的預覽回複評論結果。
   • 評論下載：使用提供的按鈕將完整的審核報告作為PDF文件下載。

審查管道

1. 抹布：創建一個從知識庫到對齊代碼塊與相關審核示例的對齊代碼塊。
2. 審查：
   • 解析項目結構
   • 分析單個文件的結構。
   • 將文件分為可管理的塊。
   • 使用抹佈為模型生成提示和上下文信息。
   • 生成和格式化評論

軟件包結構

• src/bot - 電報機器人代碼。
• src/review - 代碼評論邏輯。
• • src/review/parsers - 代碼分解邏輯

貢獻

歡迎捐款！請打開問題或提交拉動請求，以進行任何改進或錯誤修復。

執照

麻省理工學院