https://github.com/alemalvarez/auto-scheduler
LLM powered college autoscheduler - CSUS DS club
https://github.com/alemalvarez/auto-scheduler
datascience gpt open-source openai-api python scraping
Last synced: 30 days ago
JSON representation
LLM powered college autoscheduler - CSUS DS club
- Host: GitHub
- URL: https://github.com/alemalvarez/auto-scheduler
- Owner: alemalvarez
- License: mit
- Created: 2024-03-07T19:33:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-19T23:04:49.000Z (about 1 year ago)
- Last Synced: 2024-04-20T00:21:44.522Z (about 1 year ago)
- Topics: datascience, gpt, open-source, openai-api, python, scraping
- Language: Jupyter Notebook
- Homepage:
- Size: 7.52 MB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🐍 LLM powered autoscheduler - CSUS DS Club
*Tested and developed using **Python 3.11.5**!*
The **LLM-based Autoscheduler** is a project developed by the Data Science Club at CSUS, aiming to provide an automated scheduling system for students. 📅 The project comprises three main components:
1. **Scraper** 🕵️♂️
2. **LLM API Connection** 🤖
3. **User Interface Application** 💻
## 1. Scraper 🕵️♂️
⚠️ **Important: The included chromium engine ONLY runs on ARM MacOS (Apple silicon chips). If your system is different, you can find the appropiate version in [Chrome for Testing](https://googlechromelabs.github.io/chrome-for-testing/) ⚠️**
The scraper is a Python-based module that retrieves class schedule data from the CSUS webpage. It utilizes [Selenium](https://www.selenium.dev/documentation/webdriver/) and [BeautifulSoup](https://pypi.org/project/beautifulsoup4/) to navigate the website, render dynamic content, and parse the HTML structure.
The scraper performs the following tasks:
- Retrieves the rendered HTML content of the class schedule page.
- Parses the HTML structure using BeautifulSoup to extract relevant data.
- Stores the extracted data in a structured format (JSON) for further processing.
## 2. LLM API Connection 🤖
The LLM (Large Language Model) API Connection module establishes a connection with a language model API, in this case OpenAI GPT-3.5. This module is responsible for sending prompts to the LLM and receiving the generated responses.
The LLM API Connection module performs the following tasks:
- Authenticates with the LLM API service using provided credentials.
- Formats and sends prompts to the LLM API, including the extracted class schedule data.
- Receives and processes the generated responses from the LLM.
- Applies any necessary post-processing or formatting to the LLM responses.
## 3. User Interface Application 💻
The User Interface Application provides a graphical interface for users to interact with the LLM-based Autoscheduler. It acts as a bridge between the user and the underlying scraper and LLM API Connection components. It's build using the fantastic library [streamlit.io](https://streamlit.io), which provides a clean-looking UI on top of Python apps.
The User Interface Application offers the following features:
1. A user-friendly interface for inputting preferences and constraints for scheduling (e.g., desired courses, time preferences, workload limitations).
2. Integration with the scraper module to retrieve the latest class schedule data from the scraped JSON files.
3. Integration with the LLM API Connection module to send prompts and receive generated schedules from the LLM.
4. Display of the generated schedules in a clear and organized manner.
## Getting Started! 🎉
To see the LLM-based Autoscheduler project in action, follow these steps:
1. Clone the repository: `git clone https://github.com/yourusername/llm-based-autoscheduler.git`
2. Install the required dependencies. `pip install -r dependencies.txt`
3. Configure the necessary API keys and credentials for the OpenAI API. ([Tutorial](https://openai.com/blog/openai-api))
4. Select the term in the the `scraper/scraper.py` code.
5. Run the scraper `python3 scraper.py` to generate the file `schedules/{term}.json/`.
6. Go into the folder containing the streamlit app `cd streamlit`.
7. Run the app with `streamlit run app.py`.
8. Access the app at `http://localhost:8501`.
## Contributing 🤝
Contributions to the LLM-based Autoscheduler project are welcome! If you'd like to contribute, please follow these steps:
1. Fork the repository
2. Create a new branch: `git checkout -b my-new-feature`
3. Make your changes and commit them: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
## License
*This project is licensed under the MIT License.* 📜