team-work-ai-Slava1111

0
4 месяца назад
5 месяцев назад
4 месяца назад
4 месяца назад
4 месяца назад
4 месяца назад
5 месяцев назад
4 месяца назад
4 месяца назад
README.md

##Gitverse аккаунты:

Student 1: Slava1111

Student 2: Teyu

Student 3: discocat

(Я выполняла роль Student 2 в работе Teyu)


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

Работа выполнялась в Gigacode IDE 2024.3 двумя запросами.

Данный проект представляет собой API для анализа данных ресторанов на основе датасета Yelp/Kaggle. Цель — предоставить инструменты для быстрого получения статистики по рейтингам, отзывам, типам кухни и локациям без использования сложных NLP-моделей.

Работа выполнялась в рамках учебного задания (Вариант 10) в папке

dev
, где реализован основной функционал в файле
solution.py
.


Функционал API

API реализует следующие функции:

get_top_restaurants(cuisine, location, min_reviews)

Возвращает список лучших ресторанов, отфильтрованных по типу кухни, локации и минимальному количеству отзывов.

get_cuisine_statistics(location)

Позволяет получить средний рейтинг по типам кухни для указанной локации.

get_review_sentiment_summary(restaurant_name)

Выполняет простой анализ тональности отзывов (позитивные/негативные/нейтральные) для конкретного ресторана с помощью ключевых слов.


Входные данные

Ожидается CSV-файл со следующими полями:

  • restaurant_name
    — название ресторана
  • cuisine
    — тип кухни
  • location
    — город/штат
  • rating
    — рейтинг (1–5, float)
  • review_count
    — количество отзывов
  • avg_review_rating
    — средний рейтинг отзывов
  • review_text
    — текст отзыва (опционально)

Выходные данные

Результат работы API возвращается в формате JSON с полями:

  • avg_rating
    — средний рейтинг
  • top_cuisines
    — топ-кухни
  • location_statistics
    — статистика по локациям
  • review_sentiment_distribution
    — распределение тональности отзывов
  • restaurant_count
    — количество ресторанов, соответствующих критериям фильтрации

Ограничения

  • Анализ тональности отзывов выполняется без NLP-моделей — только по ключевым словам.
  • Рейтинги ограничены шкалой от 1 до 5 звезд.
  • Поддерживается фильтрация по типу кухни и локации.

Структура репозитория

project-root/

├── dev/ # Основной код решения

│ └── solution.py # Реализация API-функций

├── demo/ # Пример входных данных

│ └── sample_data.csv # CSV-файл с данными о ресторанах

├── spec/ # Техническое задание

│ └── codex.md # Документация спецификации

├── tasks/ # Задачи и требования

├── CONTRIBUTING.md # Инструкция по вкладу в проект

└── README.md # Данный файл