Update README.md
Browse files
README.md
CHANGED
@@ -1,39 +1,53 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
-
|
13 |
-
|
14 |
-
|
15 |
-
|
16 |
-
|
17 |
-
|
18 |
-
|
19 |
-
|
20 |
-
|
21 |
-
|
22 |
-
|
23 |
-
-
|
24 |
-
|
25 |
-
|
26 |
-
|
27 |
-
|
28 |
-
|
29 |
-
|
30 |
-
|
31 |
-
|
32 |
-
|
33 |
-
|
34 |
-
|
35 |
-
|
36 |
-
|
37 |
-
|
38 |
-
|
39 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
title: University AI Chatbot
|
3 |
+
emoji: π
|
4 |
+
colorFrom: red
|
5 |
+
colorTo: yellow
|
6 |
+
sdk: gradio
|
7 |
+
sdk_version: "4.18.0"
|
8 |
+
app_file: app.py
|
9 |
+
pinned: false
|
10 |
+
---
|
11 |
+
|
12 |
+
A student-friendly AI chatbot that simplifies university handbook queries.
|
13 |
+
|
14 |
+
|
15 |
+
# π University Inquiries AI Chatbot
|
16 |
+
|
17 |
+
A conversational AI chatbot that helps students navigate and understand the official university handbook using natural language. Built with Gradio, Sentence Transformers, and FLAN-T5, it offers friendly and accurate responses based on handbook content β with built-in feedback tracking and upvote/downvote tuning.
|
18 |
+
|
19 |
+
---
|
20 |
+
|
21 |
+
## β¨ Features
|
22 |
+
|
23 |
+
- π§ **Semantic Search:** Uses Sentence Transformers to find the closest handbook Q&A to a student's question.
|
24 |
+
- π£οΈ **LLM Explanation:** Automatically rewrites formal handbook responses in a student-friendly tone using FLAN-T5.
|
25 |
+
- π **Feedback Memory:** Stores user feedback (upvotes/downvotes) to improve future responses.
|
26 |
+
- π **Smart Matching:** Merges similar feedback questions (β₯80% similarity) to avoid duplication.
|
27 |
+
- π¨ **Custom UI:** Includes a PUP-themed responsive design with a gradient background and styled chat layout.
|
28 |
+
|
29 |
+
|
30 |
+
---
|
31 |
+
|
32 |
+
## π§° Tech Stack
|
33 |
+
|
34 |
+
- [Gradio](https://gradio.app/) β for UI interface
|
35 |
+
- [Sentence Transformers](https://www.sbert.net/) β for question embedding & similarity
|
36 |
+
- [Transformers (FLAN-T5)](https://huggingface.co/google/flan-t5-small) β for natural explanation generation
|
37 |
+
- JSON β for persistent feedback storage
|
38 |
+
|
39 |
+
---
|
40 |
+
|
41 |
+
## π Files
|
42 |
+
|
43 |
+
- `app.py` β main chatbot logic & interface
|
44 |
+
- `dataset.json` β official university Q&A set
|
45 |
+
- `feedback.json` β live feedback database
|
46 |
+
- `README.md` β this file!
|
47 |
+
|
48 |
+
---
|
49 |
+
|
50 |
+
## π¦ Installation
|
51 |
+
|
52 |
+
```bash
|
53 |
+
pip install -r requirements.txt
|