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 - 代码分解逻辑

贡献

欢迎捐款！请打开问题或提交拉动请求，以进行任何改进或错误修复。

执照

麻省理工学院