neoleksiy / recsysapi

Recommendation System API

RecSysApi - Рекомендательная система, с доступом по Api

Стек:

• Django + Django REST framework
• PostgresSQL - база данных
• SwaggerUI - OpenApi документирование
• Numpy, Scipy, Pandas, sklearn - библиотеки для машинного обучения

Как запустить:

1. В терминале git clone https://github.com/NeOleksiy/friends_service.git
2. В терминале docker-compose up --build
3. В терминале docker-compose run web python manage.py makemigrations
4. В терминале docker-compose run web python manage.py migrate

• Если нужно загрузить тестовые данные, на которых делался и тестировался проект, то
• python -m auxiliary_func.fill_anime.py
• python -m auxiliary_func.fill_ratings.py(Загружается в бд примерно 3-5 часов)

Как работает:

Для доступа к документации OpenApi переходим по http://127.0.0.1:8000/swagger-ui/

Рекомендательная система состоит из 4х модулей:

rec

Основной модуль, где делаются рекомендации, их тут 4 вида:

• popularity - Рекомендация самых популярных аниме
• collaborate_filltering - item to item рекомендации, требуют наличия определённого кол-ва оценок для хорошей работы.
• ContentBased - рекомендации на основе контента(жанров), требуют хотя бы одного оценённого аниме
• FWLS - гибридные рекомендации, которые обучаются линейной регрессией с весовыми функциями, которые в зависимости от кол-ва оценок возвращают 0 или 1, основной тип персонализированных рекомендаций для пользователя

Пример:

Для доступа к рекомендациям нужно предварительно авторизоваться и поставить нужное кол-во оценок

ContentBased рекомендации,переходим по http://127.0.0.1:8000/rec/content_based

user

Модуль реализует логику регистрации, авторизации и взаимодействия с списком просмотренных аниме

Пример:

Регистрация пользователя переходим по http://127.0.0.1:8000/user/register

collect

Сборщик данных, собирающий логи дейсвия пользователя

Действия

product

Модуль для взаимодействия с контентом

recsysapi's Issues

Получение списка аниме

Получение списка аниме get запросом, разумеется по Rest Api.
Также добавить пагинацию, чтобы на одной страницы выводилось 30 аниме за раз.
https://www.django-rest-framework.org/api-guide/pagination/

Создать таблицы для тестовых данных

#Создать 2 таблицы для тестовых данных по которым будет строиться рекомендации:
(предварительно выполнить миграции python manage.py migrate )

• В productApi создать таблицу аниме со столбцами из тестовых данных (https://www.kaggle.com/datasets/CooperUnion/anime-recommendations-database/data?select=anime.csv) . Там же надо будет создать таблицу с жанрами со связью Many to Many.
• Вторую таблицу создать в приложении users с рейтингами со связью Many to Many (таблицы с пользователем и аниме) по тем же тестовым данным

После создания этих таблицы создать миграции python manage.py makemigrations и выполнить их.
Также занести эти данные в таблицу и протестить их вывод(Можно ли так сказать прочитать данные в таблице)

Аутентификация пользователя

В приложении users обновить модель пользователя и добавить аутентификацию юзера (https://www.django-rest-framework.org/api-guide/authentication/) . Так как работаем локально также нужно будет создать базу данных как в .env файле.
Также заранее нужно будет сделать первую миграцию python manage.py migrate . И разумеется создать новую python manage.py makemigrations.