oceddyyy commited on
Commit
bc93999
Β·
verified Β·
1 Parent(s): 9dd97e1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +53 -39
README.md CHANGED
@@ -1,39 +1,53 @@
1
- # πŸŽ“ University Inquiries AI Chatbot
2
-
3
- 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.
4
-
5
- ---
6
-
7
- ## ✨ Features
8
-
9
- - 🧠 **Semantic Search:** Uses Sentence Transformers to find the closest handbook Q&A to a student's question.
10
- - πŸ—£οΈ **LLM Explanation:** Automatically rewrites formal handbook responses in a student-friendly tone using FLAN-T5.
11
- - πŸ‘ **Feedback Memory:** Stores user feedback (upvotes/downvotes) to improve future responses.
12
- - πŸ”„ **Smart Matching:** Merges similar feedback questions (β‰₯80% similarity) to avoid duplication.
13
- - 🎨 **Custom UI:** Includes a PUP-themed responsive design with a gradient background and styled chat layout.
14
-
15
-
16
- ---
17
-
18
- ## 🧰 Tech Stack
19
-
20
- - [Gradio](https://gradio.app/) β€” for UI interface
21
- - [Sentence Transformers](https://www.sbert.net/) β€” for question embedding & similarity
22
- - [Transformers (FLAN-T5)](https://huggingface.co/google/flan-t5-small) β€” for natural explanation generation
23
- - JSON β€” for persistent feedback storage
24
-
25
- ---
26
-
27
- ## πŸ“ Files
28
-
29
- - `app.py` β€” main chatbot logic & interface
30
- - `dataset.json` β€” official university Q&A set
31
- - `feedback.json` β€” live feedback database
32
- - `README.md` β€” this file!
33
-
34
- ---
35
-
36
- ## πŸ“¦ Installation
37
-
38
- ```bash
39
- pip install -r requirements.txt
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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