jwradhe/TV-Show-recommender
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
jwradhe 2024-11-21 01:02:25 +01:00
parent eece950755
commit 37ef4ade85
1 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -22,18 +22,33 @@
2. **Install Dependencies:** 2. **Install Dependencies:**
- Install the necessary libraries listed in `requirements.txt` (see below). - Install the necessary libraries listed in `requirements.txt` (see below).
3. **Run the Program:** ### Running the Program
- Start the program by running the following command:
There are two ways to run the program, depending on whether you prefer to use the web-based interface or the command-line interface (CLI).
#### Web Interface (Flask)
To run the web-based interface (Flask application):
```bash
python app.py
```
```bash This will start a local web server, and you can access the app through your browser (usually at http://127.0.0.1:5000/).
python app.py The program will load the dataset, prompt you to enter a TV show title, and ask how many recommendations you want.
```
#### Command-Line Interface (Python-GUI)
- The program will load the dataset, ask for a TV show title to base recommendations on, and prompt for the number of recommendations. To run the command-line version of the program:
```bash
python main.py
```
> [!NOTE] The program will work in the terminal, asking you to enter the title of a TV show you like and how many recommendations you want.
> The first time the program is run, it will generate **Sentence-BERT embeddings**. This can take up to 5 minutes due to the large size of the dataset.
> [!NOTE]
> The first time the program is run, it will generate **Sentence-BERT embeddings**. This can take up to 5 minutes due to the large size of the dataset.
--- ---