sahsan bmendoza40 commited on
Commit
09bc68e
Β·
verified Β·
1 Parent(s): 7d42f70

Update README.md (#3)

Browse files

- Update README.md (1bf507ffee815678e7bf7eaabf7c42840a4555c7)


Co-authored-by: Ben Mendoza <[email protected]>

Files changed (1) hide show
  1. README.md +2 -2
README.md CHANGED
@@ -15,7 +15,7 @@ license: apache-2.0
15
  ## Project Title: Academic Advisement Bot
16
 
17
  ### Description
18
- The Academic Advisement Bot is a Streamlit application designed to assist students with course advisement, leveraging a Retrieval-Augmented Generation (RAG) system. It provides detailed and accurate answers to student queries regarding course prerequisites, corequisites, semester plans, and general education requirements based on the Computer Engineering Technology (CET) curriculum. The bot also includes user authentication, API key management, and an automated evaluation system for its performance.
19
 
20
  ### Features
21
  * **Conversational AI:** Utilizes a RAG chain to provide context-aware answers to academic queries.
@@ -52,7 +52,7 @@ cet_advisement_bot/
52
  β”‚ β”œβ”€β”€ index.faiss
53
  β”‚ └── index.pkl
54
  β”œβ”€β”€ queries/
55
- β”‚ └── QueriesDataSet_Final.xlsx <-- Dataset for automated evaluation
56
  └── src/
57
  β”œβ”€β”€ app.py <-- Main Streamlit application, handles UI, auth, and chat
58
  β”œβ”€β”€ chains.py <-- Defines the RAG chain and retriever
 
15
  ## Project Title: Academic Advisement Bot
16
 
17
  ### Description
18
+ The Academic Advisement Bot is an application designed to assist students with course advisement, leveraging a Retrieval-Augmented Generation (RAG) system. It provides detailed and accurate answers to student queries regarding course prerequisites, corequisites, semester plans, and general education requirements based on the Computer Engineering Technology (CET) curriculum. The bot also includes user authentication, API key management, and an automated evaluation system for its performance.
19
 
20
  ### Features
21
  * **Conversational AI:** Utilizes a RAG chain to provide context-aware answers to academic queries.
 
52
  β”‚ β”œβ”€β”€ index.faiss
53
  β”‚ └── index.pkl
54
  β”œβ”€β”€ queries/
55
+ β”‚ └── QueriesDataSet_Final.xlsx <-- Dataset (queries) for evaluation.
56
  └── src/
57
  β”œβ”€β”€ app.py <-- Main Streamlit application, handles UI, auth, and chat
58
  β”œβ”€β”€ chains.py <-- Defines the RAG chain and retriever