EKS_SteamSearchEngine/README.md

24 lines
921 B
Markdown
Raw Normal View History

2022-04-05 23:23:00 +02:00
# EKS_SteamSearchEngine
A task for Information Extraction which provides you an interface to query for Steam games descriptions.
Dataset used: https://www.kaggle.com/datasets/nikdavis/steam-store-games
## Requirements
- `python3`
- (Optional) Kaggle setup with an API token
## Setup
1. Dataset is available to downloaded on Kaggle. You can either download it manually from https://www.kaggle.com/datasets/nikdavis/steam-store-games, and extract the `.zip` file contents into the `data` folder. If you have Kaggle setup with a token on your machine, you can proceed to the next step
2. Run `./setup.sh`
## Usage
Run `python3 search-engine.py`.
The program should load the data and provide you a query interface.
### Additional arguments
The search engine also uses game's popularity to provide the query results. You can disable it by providing `--no-popularity` param into the executable.