sahsan commited on
Commit
6448f12
·
1 Parent(s): 8594f6a

fixed missing README data

Browse files
Files changed (1) hide show
  1. README.md +14 -12
README.md CHANGED
@@ -1,3 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ## Project Title: Academic Advisement Bot
2
 
3
  ### Description
@@ -92,15 +106,3 @@ cet_advisement_bot/
92
 
93
  ### Usage
94
  1. **Login/Register:** Upon launching the application, you will be prompted to log in or register a new account.
95
- 2. **Set OpenAI API Key:** Navigate to the "User Panel" in the sidebar and provide your OpenAI API key. This is required for the chatbot functionality.
96
- 3. **Ask Questions:** Once authenticated and with a valid API key, you can start asking questions about the CET curriculum.
97
- 4. **Automated Evaluation:** The "Admin Panel" (or "User Panel" if admin features are integrated) allows you to run an automated evaluation of the bot's performance against a predefined set of questions.
98
-
99
- ### Contributing
100
- (Placeholder for contribution guidelines)
101
-
102
- ### License
103
- (Placeholder for license information)
104
-
105
- ### Contact
106
- (Placeholder for contact information)
 
1
+ ---
2
+ title: Cet Advisement Bot
3
+ emoji: 🚀
4
+ colorFrom: red
5
+ colorTo: red
6
+ sdk: docker
7
+ app_port: 8501
8
+ tags:
9
+ - streamlit
10
+ pinned: false
11
+ short_description: A chatbot designed to aid course advisement at City Tech
12
+ license: apache-2.0
13
+ ---
14
+
15
  ## Project Title: Academic Advisement Bot
16
 
17
  ### Description
 
106
 
107
  ### Usage
108
  1. **Login/Register:** Upon launching the application, you will be prompted to log in or register a new account.