!!! НЕ ЗАБУДЬТЕ ПЕРЕИМЕНОВАТЬ ДАННЫЙ ФАЙЛ В README.md !!!
- Что делает данный проект
- Для чего он нужен
- список функционала с точки зрения пользователя
- если есть возможность - вставить скриншоты
- результаты и достижения проекта
- метрики проекта + как оцениваются данные метрики
- что делали, какие показатели достигли
- какая стадия проекта
- потребляемые мощности
- условия эксплуатации для машинки
- ссылка на документацию проекта (дополнительную), если документация = README.md - то пункт убираем
- Краткое описание подхода
- Особенности подхода. Например: Детекция лиц и 5 ключевых точек лица.
- Тип нейронной сети. Например: Нейронная сеть архитектуры mtcnn.
- Ссылка на гит/сайт/статью где представлена архитектура нейронной сети. Например: Ссылка на гит: https://github.com/ipazc/mtcnn
- Какие метрики используются для оценки проекта
- Обучающие данные
- Используемый для обучения датасет. Например: Датасет машин на шлагбаумах Ереван Плаза.
- Ссылка на его скачивание или расположение на сервере. Если структура файлов менялась, то описать изменения. Например: Сервер xxx.xxx.xxx.xxx, папка /home/storage/erevan_binary.
- Если использовалась претрейнутая модель, то указать датасет на котором происходил претрейн. Например: Претрейн на imagenet.
- Обучающие скрипты. Если обучающие скрипты/ноутбуки сохранились, закинуть их на гит проекта в папку
train_scripts/
- тут полная инструкция по шагам, выполнив, которую можно получить работающий проект
- описать, какие внешние зависимости нужны
git clone/cd folder/python3 -m venv venv/./venv/bin/pip3 install -r requirements.txtи т.д.
- описание, как использовать проект
- какие пути API / что принимает на вход модель / что выдаёт на выход / ссылка на swagger (если есть)
- (если при использовании проекта были кейсы, частые проблемы и прочие такие моменты, которые стоит пометить - то лучше их записать сюда)
- кто писал проект и когда