updated README.md

README.md

@@ -1,23 +1,106 @@
----
-title: Cet Advisement Bot
-emoji: 🚀
-colorFrom: red
-colorTo: red
-sdk: docker
-app_port: 8501
-tags:
-- streamlit
-pinned: false
-short_description: A chatbot designed to aid course advisement at City Tech
-license: apache-2.0
----
-
-# Welcome to Streamlit!
-
-Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
-
-If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
-forums](https://discuss.streamlit.io).
-
-# Chatbot Project
-Details
+## Project Title: Academic Advisement Bot
+
+### Description
+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.
+
+### Features
+*   **Conversational AI:** Utilizes a RAG chain to provide context-aware answers to academic queries.
+*   **Course Information:** Provides detailed information on CET courses, including prerequisites, corequisites, and semester-wise plans.
+*   **User Authentication:** Secure login and registration system with password hashing and strength validation.
+*   **API Key Management:** Allows users to set and manage their OpenAI API keys for model interaction.
+*   **Automated Evaluation:** Includes a feature to run automated evaluations against predefined Q&A pairs to assess the bot's accuracy using cosine similarity.
+*   **Session Management:** Handles user sessions and timeouts.
+*   **Interactive UI:** Built with Streamlit for an intuitive and user-friendly experience.
+
+### Technologies Used
+*   **Python 3.x**
+*   **Streamlit:** Web application framework.
+*   **LangChain:** For building the RAG conversational chain.
+*   **FAISS:** For efficient similarity search on course embeddings.
+*   **Sentence Transformers:** For generating embeddings.
+*   **OpenAI API:** For language model interactions (requires user-provided API key).
+*   **SQLite3:** For user authentication and API key storage.
+*   **Pandas:** For data manipulation and evaluation results.
+*   **Scikit-learn:** For cosine similarity calculation in evaluation.
+*   **Docker:** For containerization.
+*   **Dotenv:** For environment variable management.
+
+### Project Structure
+```
+cet_advisement_bot/
+├── .gitattributes
+├── Dockerfile
+├── README.md             <-- This file
+├── requirements.txt
+├── docs/
+│   ├── original_cat.pdf  <-- Original course catalog document
+│   └── original_vector/  <-- FAISS index for course embeddings
+│       ├── index.faiss
+│       └── index.pkl
+├── queries/
+│   └── QueriesDataSet_Final.xlsx <-- Dataset for automated evaluation
+└── src/
+    ├── app.py            <-- Main Streamlit application, handles UI, auth, and chat
+    ├── chains.py         <-- Defines the RAG chain and retriever
+    ├── embeddings.py     <-- Handles embedding model loading
+    ├── history.py        <-- Manages chat history for conversational context
+    └── streamlit_app.py  <-- (Potentially deprecated or merged into app.py, needs clarification)
+```
+
+### Setup and Installation
+
+#### Prerequisites
+*   Python 3.x
+*   Docker (optional, for containerized deployment)
+*   An OpenAI API Key (to be provided within the application)
+
+#### Local Setup
+1.  **Clone the repository:**
+    ```bash
+    git clone https://github.com/your-repo/cet_advisement_bot.git
+    cd cet_advisement_bot
+    ```
+2.  **Create a virtual environment and activate it:**
+    ```bash
+    python -m venv venv
+    .\venv\Scripts\activate  # On Windows
+    source venv/bin/activate # On macOS/Linux
+    ```
+3.  **Install dependencies:**
+    ```bash
+    pip install -r requirements.txt
+    ```
+4.  **Prepare data files:**
+    The application expects `original_cat.pdf` and the `original_vector` directory (containing `index.faiss` and `index.pkl`) to be present in the `docs/` directory. These files are crucial for the RAG system. Ensure these are downloaded and placed correctly.
+    *(Note: If these files are large and hosted externally, instructions for downloading them using `gdown` or similar tools should be added here.)*
+5.  **Run the Streamlit application:**
+    ```bash
+    streamlit run src/app.py
+    ```
+    The application will open in your web browser.
+
+#### Docker Deployment
+1.  **Build the Docker image:**
+    ```bash
+    docker build -t cet-advisement-bot .
+    ```
+2.  **Run the Docker container:**
+    ```bash
+    docker run -p 8501:8501 cet-advisement-bot
+    ```
+    Access the application at `http://localhost:8501` in your browser.
+
+### Usage
+1.  **Login/Register:** Upon launching the application, you will be prompted to log in or register a new account.
+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.
+3.  **Ask Questions:** Once authenticated and with a valid API key, you can start asking questions about the CET curriculum.
+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.
+
+### Contributing
+(Placeholder for contribution guidelines)
+
+### License
+(Placeholder for license information)
+
+### Contact
+(Placeholder for contact information)