NeuroCore templates

readme-template.md

!!! НЕ ЗАБУДЬТЕ ПЕРЕИМЕНОВАТЬ ДАННЫЙ ФАЙЛ В README.md !!!

Название проекта

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

Описание

• Что делает данный проект
• Для чего он нужен
• список функционала с точки зрения пользователя
• если есть возможность - вставить скриншоты
• результаты и достижения проекта
  • метрики проекта + как оцениваются данные метрики
  • что делали, какие показатели достигли
  • какая стадия проекта

Связанные репозитории

• связанные репозитории

Технические требования

• потребляемые мощности
• условия эксплуатации для машинки

Документация

• ссылка на документацию проекта (дополнительную), если документация = README.md - то пункт убираем

Документация ML проекта:

1. Краткое описание подхода
   1. Особенности подхода. Например: Детекция лиц и 5 ключевых точек лица.
   2. Тип нейронной сети. Например: Нейронная сеть архитектуры mtcnn.
   3. Ссылка на гит/сайт/статью где представлена архитектура нейронной сети. Например: Ссылка на гит: https://github.com/ipazc/mtcnn
   4. Какие метрики используются для оценки проекта
2. Обучающие данные
   1. Используемый для обучения датасет. Например: Датасет машин на шлагбаумах Ереван Плаза.
   2. Ссылка на его скачивание или расположение на сервере. Если структура файлов менялась, то описать изменения. Например: Сервер xxx.xxx.xxx.xxx, папка /home/storage/erevan_binary.
   3. Если использовалась претрейнутая модель, то указать датасет на котором происходил претрейн. Например: Претрейн на imagenet.
3. Обучающие скрипты. Если обучающие скрипты/ноутбуки сохранились, закинуть их на гит проекта в папку train_scripts/

---

Установка

• тут полная инструкция по шагам, выполнив, которую можно получить работающий проект
• описать, какие внешние зависимости нужны
• git clone / cd folder / python3 -m venv venv / ./venv/bin/pip3 install -r requirements.txt и т.д.

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

• описание, как использовать проект
• какие пути API / что принимает на вход модель / что выдаёт на выход / ссылка на swagger (если есть)

Поиск проблем

• (если при использовании проекта были кейсы, частые проблемы и прочие такие моменты, которые стоит пометить - то лучше их записать сюда)

Авторство

• кто писал проект и когда

report-template.md

Отчёт по проекту [PROJECT] 25.05.20

Результаты текущего спринта

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

1. Улучшили качество моделей
2. Закрыли задачи из gitlab:
   • [#32 Добавить админ-панель](тут ссылка на issue в gitlab)
   • [#34 Поменять цвет шапки](тут ссылка на issue в gitlab)
   • [#33 Добавить метод API getPhoto](тут ссылка на issue в gitlab)
3. Разработаны модули и функции, требуемые в пункте 4 [ТЗ](ссылка на ТЗ)

Подробное описание

1. Улучшили качество моделей

Описание, в чем заключалась задача, какие действия были сделаны для её решения, что было изменено.

2. Закрыли задачи из gitlab

Если было добавлено какое-то новое API, методы, routes и т.д. и т.п. - то они должны быть добавлены в документацию соответствующего проекта. В отчёте достаточно сказать: По изменениям при выполнении данного тикета обновлена [документация(ссылка на документацию). Если есть возможность, то тезисно списком описать, что из этого было добавлено, если в самом issue на gitlab этого нет.

• [#32 Добавить админ-панель](тут ссылка на issue в gitlab)

  • добавлена админка по пути: /admin/
  • реализован функционал по пункту 4 из ТЗ

• [#34 Поменять цвет шапки](тут ссылка на issue в gitlab)

  • изменён файл styles.css поменяли цвет с красного на синий, как просил заказчик

• описывать не надо, так как в gitlab issue уже есть описание метода [#33 Добавить метод API getPhoto](тут ссылка на issue в gitlab)

Планы на следующий спринт

1. Добавить 3 новых класса для распознавания авто
   • класс 1 - грузовики
   • класс 2 - легковые
   • класс 3 - скорая
2. Задачи из gitlab:
   • [#31 Добавить форму регистрации](тут ссылка на issue в gitlab)
   • [#35 Поменять цвет футера](тут ссылка на issue в gitlab)

---

Материалы проекта

обязательно

• [Репозиторий проекта, который изменялся в данном спринте](ссылка на фронтенд)
• [Репозиторий проекта, который изменялся в данном спринте](ссылка на бэкенд)

если есть

1. Описание датасета
2. Ссылки на датасеты
3. Процесс тестирования и полученные метрики
4. Скриншоты и прочие изображения изменений