csed_assistant

CSED Assistant

Вступление

Это простой помощник для студентов CSED, чтобы помочь им в учебе. Это простой инструмент командной строки, который можно использовать для обобщения лекций

Установка

1. Клонировать репозиторий
2. Запустите следующую команду, чтобы установить необходимые пакеты

pip install -r requirements.txt

3. Добавить ключ API Gemini к .env , вы можете получить бесплатный ключ API от Gemini Studio

Использование

• Запустите следующую команду, чтобы запустить помощника

python summarize.py {path to the lecture file( " lect1.pdf " )}

Это сделает суммирование в формате MD и PDF.

• Вы можете добавить свои собственные изменения в файл разметки и экспортировать его в качестве PDF с помощью команды:

mdpdf -o summary.pdf summary.md

• Вы можете добавить свою собственную подсказку, редактируя prompt.txt

Тестирование

Вы можете найти результаты теста в test/

Будущая работа

• Добавление веб -интерфейса для чата и загрузки документов
• Последующие вопросы по загруженному документу для получения дополнительных разъяснений
• Последующие запросы на редактирование

Вклад

Вам настоятельно рекомендуется расколоть репо и делать запросы на привлечение с помощью новых функций

Отказ от ответственности

Это простой инструмент, который может не отлично работать для всех документов. Рекомендуется просмотреть выход и внести необходимые изменения.

Наслаждаться!