diff --git a/README.md b/README.md index a172c1dea665b5fa4144040acc3cc1fcaa136b5e..3a112fc94db0cbc036157b93ed75f442ecf54dfa 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ pip install scikit-surprise pip install collections pip install random pip install tabulate +pip install streamlit +pip install requests ``` @@ -102,6 +104,26 @@ The project is organized into the following key components: - A reduced version of the small dataset for debugging purposes. +### Web Page - Overview + +Our web page serves as the user interface for the Recommender System. It allows users to interact with the recommendation models & view recommended items. It was built in backend powered by Flask (Python) to handle requests and serve recommendations. + +1. ***Features*** +- Home +- Discovery +- Search + +2. ***Access the Web Page***: + Open your web browser and go to `http://127.0.0.1:5000`. + +## References + +- [Surprise Documentation](https://surprise.readthedocs.io/en/stable/) +- [Pandas Documentation](https://pandas.pydata.org/docs/getting_started/intro_tutorials/index.html) +- [Numpy Documentation](https://numpy.org/doc/stable/user/quickstart.html) +- [Course Materials](https://forge.uclouvain.be/cvandekerckh/mlsmm2156) +- [Extra Reference 1](https://bit.ly/3qnwKXa) +- [Extra Reference 2](https://bit.ly/4cBLxDM) ## Contact