Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.29 KB

README.md

File metadata and controls

31 lines (20 loc) · 1.29 KB
Raw

TSINGHUA SEP AI Assistant

Welcome to the TSINGHUA SEP AI Assistant! This project aims to provide an intelligent assistant for students going for the Tsinghua SEP.

Developer note: I created this because I was annoyed at the lack of clear, centralised instructions and decided to pull the crazy amounts of random pieces of information in one place, and create a QA interface.

Features

  • Special hyperlink functions that open buttons in new tabs.
  • Vector store in the cache of the Streamlit Cloud platform.
  • Improved prompt engineering of the bot.
  • Logging of questions asked in the Telegram bot.

Getting Started

To get started with the TSINGHUA SEP AI Assistant, follow these steps:

  1. Clone the repository: $ git clone https://github.com/belligerentbeagle/TsinghuaSEP-Assistant.git
  2. Install the required dependencies: $ pip install -r requirements.txt
  3. Run the application: $ python main.py

Contributing

Contributions are welcome! If you would like to contribute to the TSINGHUA SEP AI Assistant, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch: $ git checkout -b feature/your-feature
  3. Make your changes and commit them: $ git commit -m "Add your feature"
  4. Push to the branch: $ git push origin feature/your-feature
  5. Submit a pull request.