evrz hackathon

برقية مراجعة الروبوت

روبوت برقية Python الذي يعالج ملفات أرشيف ، يستخرج هياكل المشروع ، رمز التحليل ، ويقوم بإنشاء تقرير المراجعة بناءً على قاعدة المعرفة المقدمة.

سمات

• دعم الملف: يقبل تنسيقات الملفات المختلفة.
• دعم الأرشيف: يقبل تنسيقات الأرشيف RAR و ZIP و 7Z.
• معاينة المراجعة: يرسل معاينة مراجعة لنتائج المراجعة.
• تنزيل المراجعة: يوفر زرًا لتنزيل تقرير المراجعة الكامل كملف PDF.
• خرقة: يستخدم خرقة لتوفير سياق للنموذج.
• LLM الصغيرة: يستخدم نموذج MISTRAL-NEMO 12B لتقديم مراجعة شاملة تتطلب أقل من 20 جيجابايت من VRAM.

يثبت

المتطلبات الأساسية

• بيثون 3.11+
• شعر إدارة التبعية. التثبيت من الموقع الرسمي للشعر
• خادم Minio مع سجل DNS لعناوين URL المعتمدة مسبقًا (سيتم توفير بيانات الاعتماد بشكل منفصل)
• تبعيات النظام :
  • لاستخراج RAR ، تأكد من تثبيت unrar على نظامك:
    • Ubuntu: sudo apt-get install unrar
    • MacOS (مع Homebrew): brew install unrar
    • Windows: غير مدعوم بسبب نقص المكتبات المدعومة.

ملاحظة مهمة للتنمية المحلية

إذا كان تشغيل الروبوت محليًا (خارج Docker) ، فستحتاج إلى التعامل مع تثبيت Pytorch بشكل منفصل:

• إما تشغيل: pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• أو إلغاء التبعية تبعية torch في pyproject.toml ومحاولة تثبيتها ، لكنها قد تفشل .

تثبيت

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 عبر مستند Manager و Cloud Drive.

3. اختر طريقة التثبيت الخاصة بك

   Docker (موصى به) :

   docker-compose up -d

   سيبدأ هذا كل من حاويات BOT و Minio Server.

   التثبيت المحلي :

   poetry install
   poetry run telegram-review-bot

الاستخدام

1. ابدأ الروبوت

   افتح البرقية وابحث عن الروبوت الخاص بك. ابدأ محادثة عن طريق إرسال /start .

2. 2.1 إرسال ملف

   إرسال ملف إلى الروبوت.

   2.2 إرسال أرشيف

   أو يمكنك إرسال ملف أرشيف (RAR ، ZIP ، 7Z) إلى الروبوت.

3. تلقي المخرجات

   • معاينة المراجعة: سوف يرد الروبوت بالمعاينة المقررة لنتائج المراجعة.
   • تنزيل المراجعة: استخدم الزر المقدم لتنزيل تقرير المراجعة الكامل كملف PDF.

مراجعة خط أنابيب

1. RAG : قم بإنشاء قاعدة بيانات متجه من قاعدة المعرفة لمحاذاة قطع الرمز مع أمثلة المراجعة ذات الصلة.
2. مراجعة :
   • هيكل المشروع تحليل
   • تحليل بنية الملفات الفردية.
   • تقسيم الملفات إلى قطع يمكن التحكم فيها.
   • استخدم RAG لإنشاء مطالبات ومعلومات سياقية للنموذج.
   • توليد وتنسيق المراجعة

بنية الحزم

• src/bot - رمز بوت Telegram.
• src/review - منطق مراجعة الكود.
• • src/review/parsers - منطق تقطيع الرمز

المساهمة

المساهمات مرحب بها! يرجى فتح مشكلة أو إرسال طلب سحب لأي تحسينات أو إصلاحات الأخطاء.

رخصة

معهد ماساتشوستس للتكنولوجيا