automated-essay-feedback

0
4 месяца назад
4 месяца назад
4 месяца назад
4 месяца назад
4 месяца назад
README.md

Automated Essay Feedback Tool (AEFT)

Описание проекта

Automated Essay Feedback Tool (AEFT) — это инструмент для автоматической оценки студенческих эссе. Он анализирует текст, выявляет грамматические ошибки, оценивает читаемость, структуру и длину эссе, а также формирует рекомендации по улучшению работы. Цель проекта — облегчить преподавателям первичную проверку эссе и предоставить студентам полезную обратную связь для самосовершенствования. Основные функции: проверка грамматики и орфографии с использованием

language-tool-python
, анализ читаемости текста с помощью Flesch-Kincaid score (
textstat
), подсчет количества слов и предложений для оценки структуры, генерация рекомендаций по улучшению текста, создание отчета по всем эссе в проекте.

Установка

git clone <repo_url> cd automated-essay-feedback python -m venv venv source venv/bin/activate # Linux/Mac venv\Scripts\activate # Windows pip install -r requirements.txt

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

from src.feedback import EssayFeedback essay = EssayFeedback('data/essays/essay1.txt') feedback = essay.generate_feedback() print(feedback) Пример вывода: { 'Grammar Issues': 3, 'Readability Score': 68.5, 'Words Count': 120, 'Sentences Count': 7, 'Recommendations': ['Review grammar mistakes', 'Simplify sentences for clarity'] } Генерация отчета по всем эссе: python scripts/generate_feedback.py Результат сохраняется в файл feedback_report.txt и содержит анализ всех эссе из папки data/essays/. Пример запуска через скрипт: python examples/run_example.py Выводится обратная связь для одного эссе, демонстрируя работу класса EssayFeedback.

Структура проекта

automated-essay-feedback/ ├─ src/ # Основной код │ └─ feedback.py # Класс анализа эссе ├─ tests/ # Unit-тесты │ └─ test_feedback.py ├─ data/essays/ # Текстовые файлы эссе │ ├─ essay1.txt │ └─ essay2.txt ├─ scripts/ # Скрипт для генерации отчета │ └─ generate_feedback.py ├─ examples/ # Примеры использования кода │ └─ run_example.py ├─ .github/workflows/ # CI/CD workflow │ ├─ tests.yml │ └─ feedback_report.yml ├─ .gitignore ├─ requirements.txt └─ README.md

CI/CD

tests.yml — проверка кода на PEP8 и запуск unit-тестов с помощью GitHub Actions. feedback_report.yml — ежедневная генерация отчета по эссе и загрузка артефакта с результатами. Для отображения статуса сборки можно использовать badge: