/Delfos-datathon-fme

Winning project of the FME Datathon 2021 Restaurant Reviews Challenge

Primary LanguageJupyter NotebookMIT LicenseMIT


Logo

Delfos' Restaurant Recommendation System for Groups

Winning project of the FME Datathon 2021 Reviews Challenge
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Finding restaurants that one may like is nowadays an easy task thanks to all the software tools we currently have. However such task becomes more difficult when instead of going by ourselves, we go to have dinner in a group. Everyone has different tastes, preferences, and budgets. Thus, it is not trivial how to combine them to select a restaurant that everybody will love.

To ease this task, we have developed a Restaurant Recommendation System that uses the restaurant prices, location, ratings, and reviews from both users and restaurants to find the perfect match for you and your companions.

This recommender can be used with the provided GUI, which allows to introduce the users, view and filter the restaurants intuitively and comfortably.

DEVELOPMENT INFORMATION

This project was developed between 13-14 November 2021 by the Delfos Team during the Datathon FME 2021, taking first place in the Reviews challenge. This challenge aimed to answer the following question:

WHAT RESTAURANTS IN BARCELONA WOULD YOU RECOMMEND TO SOMEONE?

SS1

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running you just need to follow these simple example steps!

Installation

  1. Clone the repo 
    git clone https://github.com/megaelius/Delfos-datathon-fme.git
  2. Install the necessary libraries and packages. 
    pip3 install -r requirements.txt

(back to top)

Usage

To use the Delfos' Recommender GUI the following command needs to be executed:

streamlit run app.py

Then, in the initial page of the app we can select which users are going to eat out:

SS2

Once all of them have been introduced, clicking in the Find restaurants! button. A newer page will pop up, showing the five restaurants that fit best the integrants of the groups according to their reviews. If needed, using the slider on the left , results can be filtered by price and distance.

SS3

In case you want to use the recommender from the terminal, this is possible by executing:

python3 terminal.py

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact



Project Link: https://github.com/megaelius/Delfos-datathon-fme

(back to top)

Acknowledgments

SS4

(back to top)