README.md

GuideGenie

Preliminary Machine learning project to recommend a Professor to a student from a network of professors looking for a mentor or a guide.

Demo

Here's a short demo video of our web app.

Quickstart

Create an environment

python -m venv <venv>

Activate the virtual environment.

For Windows

<venv>\Scripts\activate.bat

For MacOS and Linux

source <venv>/bin/activate

Install dependencies

pip install -r requirements.txt

Run the streamlit app

streamlit run main.py

Additional scripts

Web scraping

Original data was scraped from the university website.

Run the below command from the project directory to scrap the professor's data. A professor_data.csv file will be generated.

python scripts/professor_data_scraper.py

Professor Embedding

Gemini AI was used to generate embeddings of professor data.
Note: You need to replace it with your Gemini-AI API key.

Run the below command from the project directory to generate embedding of the professor's data. A data_with_embedding.csv file will be generated.

python scripts/embedding_generator.py

Contributors