Этот репозиторий создан из шаблона и используется одновременно для:
- выполнения домашних заданий по семинарам;
- разработки и демонстрации итогового проекта.
Пожалуйста, не меняйте базовую структуру каталогов (homeworks/ и project/), чтобы преподавателю было проще проверять работы.
Заполните этот блок перед началом работы:
- ФИО: Ким Андрей Павлович
- Группа: БББО-12-24
- Контакт: @Vanq5
В репозитории предусмотрены две основные области:
homeworks/– домашние задания по семинарам;project/– итоговый мини-проект.
Подробнее:
-
homeworks/README.md– краткие правила оформления домашних заданий.HW01/,HW02/,HW03/, ... – отдельная папка под каждое задание. Для каждого задания должен быть один основной файл с таким же номером, например:homeworks/HW01/HW01.ipynbhomeworks/HW02/HW02.ipynb- и т.д.
-
project/README.md– паспорт проекта и инструкции по запуску.report.md– отчёт по проекту (постановка задачи, данные, эксперименты, результаты).self-checklist.md– чеклист самопроверки проекта перед сдачей.requirements.txt– зависимости только для проекта.notebooks/– экспериментальные ноутбуки, EDA, прототипы.src/– основной код проекта (модули, пайплайны, сервисы).data/– демонстрационные/учебные данные (без персональных и конфиденциальных данных).configs/– конфигурационные файлы, шаблоны.env.exampleи т.п.tests/– тесты (если используются).artifacts/– сохранённые модели, отчёты, артефакты обучения.
-
Для каждого нового задания создавайте папку:
homeworks/HW01/homeworks/HW02/homeworks/HW03/- и т.д.
-
Основной файл задания должен называться:
HW01.ipynbв папкеHW01/;HW02.ipynbв папкеHW02/;- и т.п.
-
При необходимости вы можете добавлять дополнительные файлы в соответствующую папку (
.py, дополнительные ноутбуки, вспомогательные данные), если это не противоречит требованиям задания. -
Не переименовывайте папку
homeworks/и папки форматаHWNN/(например,HW01/,HW02/и т.п.), чтобы не ломать автоматическую и визуальную проверку.
- Весь код и материалы проекта размещайте только в папке
project/. - В файле
project/README.mdопишите:- цель проекта;
- краткую идею;
- как запустить проект (команды, зависимости, параметры);
- как воспроизвести демонстрацию для защиты.
- Отдельный отчёт по проекту ведите в файле
project/report.md:- постановка задачи и метрики;
- описание данных и экспериментов;
- сравнение моделей и выбор финальной модели.
- Для самопроверки перед сдачей используйте чеклист в
project/self-checklist.md. - Все зависимости проекта фиксируйте в
project/requirements.txt.
Итоговая оценка за проект выставляется по пятибалльной шкале (2–5) и зависит от:
- соблюдения минимальных требований к работоспособности сервиса и структуре проекта;
- количества выполненных пунктов чеклиста в
project/self-checklist.md; - качества отчёта
project/report.mdи общей аккуратности реализации.
Ориентировочно:
- если проект не выполняет минимальные требования (не запускается, отсутствует ключевой функционал, грубые нарушения, явный плагиат) – оценка 2;
- если минимум пройден, но по чеклисту выполнено меньше 5 пунктов – оценка 3;
- если по чеклисту выполнено не менее 5 пунктов – оценка 4;
- если по чеклисту выполнено не менее 9 пунктов – оценка 5.
Окончательное решение по оценке остаётся за преподавателем и может учитывать дополнительные сильные стороны проекта и соблюдение дедлайнов.
- Не коммитьте в репозиторий пароли, токены, ключи, файлы с реальными персональными данными третьих лиц и закрытые датасеты.
- Если в проекте нужны данные, используйте:
- открытые датасеты;
- синтетические данные;
- обезличенные/анонимизированные выборки.
Подробные правила и ограничения описаны в файле SECURITY.md. Пожалуйста, ознакомьтесь с ним перед началом работы.