RusTextProf

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

• /researches - исследовательские работы
• /prototype - прототипы сервисов
• /docs - документация
• /data - исходные данные и скрипты взаимодействия с ними
• /shared - общие пакеты
• /tools - различные вспомогательные утилиты

Прототип

Прототип позволяет выполнять автоматическое профилирование автора текста на русском языке. Пользователь может ввести текст вручную, загрузить из файла или выбрать готовый пример. Результат последнего прогноза сохраняется в хранилище браузера (localstorage) и отображается на странице профиля.

При запуске прогнозирования доступен выбор модели.

Для работы прототипа необходимо запустить backend и frontend сервисы. Инструкции по запуску приведены в файлах /prototype/backend/readme.md и /prototype/frontend/readme.md соответственно.

Исследования

Все исследования располагаются в researches

Формат наименования исследования

research_ГОДМЕСЯЦ_АВТОР_ПОРЯДКОВЫЙНОМЕР_ТЕМА, где: Где:

• ГОДМЕСЯЦ - год и месяц начала исследования (202602)
• АВТОР - никнейм исследователя в нижнем регистре
• ПОРЯДКОВЫЙНОМЕР - номер исследования автора в этом месяце (01, 02...)
• ТЕМА - краткое описание темы исследования (через нижние подчеркивания)

Пример - research_202602_skuld_01_industrial_practice

Git

Формат коммитов

<type>(<scope>): <краткое описание>

[ необязательное подробное описание ]

Основные типы коммитов:

• data - изменения исходных данных или связанных скриптов
• docs - изменение документации
• research(*research_short_name*) - исследовательская работа
• chore - служебные изменения
• prototype(*service_name*) - изменения сервисов прототипа
• shared(*util_name*) - изменения общего пакета
• tools(*tool_name*) - изменение утилиты

Примеры коммитов

1. Обновление документации

docs: Добавить информацию о технологиях в презентации НИРС

Добавлены слайд об использованных технологиях
Обновлены ссылки на репозитории

2. Работа с исследованиями

research(202602_skuld_01): Добавить анализ признака LTR

Построена диаграмма распределения признака LTR
Рассчитаны статистики: mean=0.45, std=0.12
Добавлен вывод о нормальности распределения

3. Служебные изменения проекта

chore: Исключить библиотеки python-проектов из git

Добавлен .venv в .gitignore
Добавлены паттерны для pycache и .pytest_cache
Обновлен .gitignore для Jupyter ноутбуков

4. Работа с прототипом

prototype(api): Добавить эндпоинт снятия метрик с текста

POST /api/v1/metrics
Поддерживаемые метрики: LTR, сложность, тональность
Добавлена валидация входного JSON