Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -8,82 +8,3 @@ sdk_version: 5.49.1
|
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
---
|
| 11 |
-
---
|
| 12 |
-
title: PSAU AI Chatbot and Course Recommender
|
| 13 |
-
emoji: 🤖
|
| 14 |
-
colorFrom: blue
|
| 15 |
-
colorTo: purple
|
| 16 |
-
sdk: gradio
|
| 17 |
-
sdk_version: 4.44.0
|
| 18 |
-
app_file: app.py
|
| 19 |
-
pinned: false
|
| 20 |
-
license: mit
|
| 21 |
-
short_description: AI-powered chatbot and course recommendation system for university admissions
|
| 22 |
-
---
|
| 23 |
-
|
| 24 |
-
# PSAU AI Chatbot and Course Recommender
|
| 25 |
-
|
| 26 |
-
An intelligent AI-powered chatbot and course recommendation system designed for university admissions. This system helps prospective students get answers to common questions and receive personalized course recommendations based on their academic profile and interests.
|
| 27 |
-
|
| 28 |
-
## Features
|
| 29 |
-
|
| 30 |
-
### 🤖 AI Chatbot
|
| 31 |
-
- **Smart FAQ System**: Uses advanced sentence transformers for semantic understanding
|
| 32 |
-
- **Intelligent Matching**: Provides accurate answers with confidence scoring
|
| 33 |
-
- **Question Suggestions**: Offers related questions based on user input
|
| 34 |
-
- **Natural Language Processing**: Understands various ways of asking the same question
|
| 35 |
-
|
| 36 |
-
### 🎯 Course Recommender
|
| 37 |
-
- **Machine Learning Powered**: Uses K-Nearest Neighbors algorithm for personalized recommendations
|
| 38 |
-
- **Multi-factor Analysis**: Considers academic performance (stanine, GWA), strand, and hobbies
|
| 39 |
-
- **Comprehensive Course Database**: Covers various academic programs
|
| 40 |
-
- **Real-time Recommendations**: Instant course suggestions based on user profile
|
| 41 |
-
|
| 42 |
-
## How to Use
|
| 43 |
-
|
| 44 |
-
### Chatbot
|
| 45 |
-
1. Type your question in the chat interface
|
| 46 |
-
2. Get instant, accurate answers about university admissions
|
| 47 |
-
3. Use suggested questions to explore more topics
|
| 48 |
-
4. Ask follow-up questions for clarification
|
| 49 |
-
|
| 50 |
-
### Course Recommender
|
| 51 |
-
1. Enter your academic information:
|
| 52 |
-
- **Stanine score**: Type a number between 1-9 (from entrance exam)
|
| 53 |
-
- **GWA**: Type your General Weighted Average (75-100)
|
| 54 |
-
- **High school strand**: Select from dropdown (STEM, ABM, HUMSS)
|
| 55 |
-
- **Hobbies and interests**: Describe your interests in detail
|
| 56 |
-
2. Click "Get Recommendations" to receive personalized course suggestions
|
| 57 |
-
3. View detailed explanations and match scores for each recommendation
|
| 58 |
-
4. Explore different combinations to see how they affect recommendations
|
| 59 |
-
|
| 60 |
-
## Technical Details
|
| 61 |
-
|
| 62 |
-
- **AI Model**: sentence-transformers (all-MiniLM-L6-v2)
|
| 63 |
-
- **ML Algorithm**: K-Nearest Neighbors
|
| 64 |
-
- **Framework**: Flask with Gradio interface
|
| 65 |
-
- **Data**: Static FAQ database and course catalog
|
| 66 |
-
- **Language**: Python 3.8+
|
| 67 |
-
|
| 68 |
-
## API Endpoints
|
| 69 |
-
|
| 70 |
-
- `GET /health` - System health check
|
| 71 |
-
- `GET /status` - Detailed system status
|
| 72 |
-
- `GET /faqs` - Get all available FAQs
|
| 73 |
-
- `POST /ask_question` - Submit question to chatbot
|
| 74 |
-
- `POST /api/recommend` - Get course recommendations
|
| 75 |
-
- `POST /api/save_ratings` - Save user feedback
|
| 76 |
-
|
| 77 |
-
## Development
|
| 78 |
-
|
| 79 |
-
This system is built with:
|
| 80 |
-
- **Backend**: Flask, sentence-transformers, scikit-learn
|
| 81 |
-
- **Frontend**: Gradio for the web interface
|
| 82 |
-
- **AI/ML**: PyTorch, sentence-transformers for NLP
|
| 83 |
-
- **Data Processing**: pandas, numpy
|
| 84 |
-
|
| 85 |
-
## License
|
| 86 |
-
|
| 87 |
-
MIT License - Feel free to use and modify for your own projects.
|
| 88 |
-
|
| 89 |
-
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|