URLs, prompts and README

README.md

@@ -2,7 +2,9 @@
 
 ## Overview
 
-This repository contains an LLM-powered chatbot designed for the [DS701: Tools for Data Science](https://tools4ds.github.io/fa2024/) course at Boston University. The chatbot serves as an interactive learning assistant, helping students with course-related queries, explanations of concepts, and guidance on data science tools.
+This repository contains an LLM-based chatbot designed for the [DS701: Tools for Data Science](https://tools4ds.github.io/fa2024/) course at Boston University. The chatbot serves as an interactive learning assistant, helping students with course-related queries, explanations of concepts, and guidance on data science tools. It is powered by [edubotics-core](https://github.com/edubotics-ai/edubotics-core) a package of modules for data loading, vector store creation and management.
+
+The chatbot will be available on HuggingFace Spaces soon. Lecture slides are available [here].
 
 ## Features
 
@@ -12,18 +14,50 @@ This repository contains an LLM-powered chatbot designed for the [DS701: Tools f
 - Practice problem suggestions and explanations
 - Course syllabus and schedule information
 
-## Getting Started
+## Getting Started Locally
 
-To use the chatbot, follow these steps:
+To run the chatbot locally, follow these steps:
 
 1. Clone this repository
-2. Install the required dependencies (see `requirements.txt`)
-3. Set up the necessary environment variables (see `.env.example`)
-4. Run the chatbot application
+
+   `git clone https://github.com/tools4ds/ds701-tutor.git`
+
+2. Set up your Python environment
+
+   a. Using venv (Python's built-in virtual environment):
+
+   ```python
+   python -m venv ds701_env
+   source ds701_env/bin/activate  # On Windows, use: ds701_env\Scripts\activate
+   pip install -r requirements.txt
+   ```
+
+   b. Using Conda:
+
+   ```python
+   conda create --name ds701_env python=3.9
+   conda activate ds701_env
+   conda install --file requirements.txt
+   ```
+
+Note: Make sure to use Python 3.9 or later.
+
+3. Install dependencies
+
+   `pip install edubotics-core`
+
+4. Run the chatbot
+
+   ```python
+    cd apps/ai-tutor
+    python app.py
+   ```
+
+   and navigate to localhost:8000 in your browser.
 
 ## Usage
 
-Students can interact with the chatbot through a web interface or command-line application. Simply type your questions or select from predefined topics to get started.
+Students can interact with the chatbot through the web interface.
 
 Example queries:
 
@@ -33,7 +67,13 @@ Example queries:
 
 ## Contributing
 
-We welcome contributions from students and instructors to improve the chatbot's knowledge base and functionality. Please see `CONTRIBUTING.md` for guidelines on how to submit improvements or report issues.
+We welcome contributions from the community to enhance the DS701 AI Tutor. Whether you're a student, instructor, or developer, your input is valuable. Here's how you can contribute:
+
+1. Fork the repository and create your feature branch.
+2. Make your changes, ensuring they align with the project's goals.
+3. Submit a pull request with a clear description of your improvements.
+
+For more detailed information on the contribution process, please refer to our `CONTRIBUTING.md` file (unavailable yet).
 
 ## Privacy and Data Handling
 

apps/ai_tutor/chainlit_app.py

@@ -239,23 +239,23 @@ class Chatbot:
             print(e)
             return [
                 cl.Starter(
-                    label="recording on Transformers?",
-                    message="Where can I find the recording for the lecture on Transformers?",
+                    label="What is this course about?",
+                    message="What is this course about? I'm not sure I'm in the right class.",
                     icon="/public/assets/images/starter_icons/adv-screen-recorder-svgrepo-com.svg",
                 ),
                 cl.Starter(
-                    label="where's the schedule?",
+                    label="Where is the schedule?",
                     message="When are the lectures? I can't find the schedule.",
                     icon="/public/assets/images/starter_icons/alarmy-svgrepo-com.svg",
                 ),
                 cl.Starter(
-                    label="Due Date?",
-                    message="When is the final project due?",
+                    label="When are office hours?",
+                    message="When are the office hours for this course?",
                     icon="/public/assets/images/starter_icons/calendar-samsung-17-svgrepo-com.svg",
                 ),
                 cl.Starter(
-                    label="Explain backprop.",
-                    message="I didn't understand the math behind backprop, could you explain it?",
+                    label="Explain KMeans",
+                    message="I didn't understand the math behind KMeans, could you explain it?",
                     icon="/public/assets/images/starter_icons/acastusphoton-svgrepo-com.svg",
                 ),
             ]

apps/ai_tutor/config/prompts.py

@@ -5,15 +5,15 @@ prompts = {
             "Incorporate relevant details from the chat history to make the question clearer and more specific. "
             "Do not change the meaning of the original statement, and maintain the student's tone and perspective. "
             "If the question is conversational and doesn't require context, do not rephrase it. "
-            "Example: If the student previously asked about backpropagation in the context of deep learning and now asks 'what is it', rephrase to 'What is backpropagation.'. "
-            "Example: Do not rephrase if the user is asking something specific like 'cool, suggest a project with transformers to use as my final project' "
+            "Example: If the student previously asked about normalization in the context of data science and now asks 'what is it', rephrase to 'What is normalization?' "
+            "Example: Do not rephrase if the user is asking something specific like 'cool, suggest a project with SVMs to use as my final project' "
             "Chat history: \n{chat_history}\n"
             "Rephrase the following question only if necessary: '{input}'"
             "Rephrased Question:'"
         ),
         "prompt_with_history": {
             "normal": (
-                "You are an AI Tutor for the course DS598, taught by Prof. Thomas Gardos. Answer the user's question using the provided context. Only use the context if it is relevant. The context is ordered by relevance. "
+                "You are an AI Tutor for the course DS701, taught by Prof. Thomas Gardos and Prof. Scott Ladenheim. Answer the user's question using the provided context. Only use the context if it is relevant. The context is ordered by relevance. "
                 "If you don't know the answer, do your best without making things up. Keep the conversation flowing naturally. "
                 "Use chat history and context as guides but avoid repeating past responses. Provide links from the source_file metadata. Use the source context that is most relevant. "
                 "Render math equations in LaTeX format between $ or $$ signs, stick to the parameter and variable icons found in your context. Be sure to explain the parameters and variables in the equations."
@@ -26,7 +26,7 @@ prompts = {
                 "AI Tutor:"
             ),
             "eli5": (
-                "You are an AI Tutor for the course DS598, taught by Prof. Thomas Gardos. Your job is to explain things in the simplest and most engaging way possible, just like the 'Explain Like I'm 5' (ELI5) concept."
+                "You are an AI Tutor for the course DS701, taught by Prof. Thomas Gardos and Prof. Scott Ladenheim. Your job is to explain things in the simplest and most engaging way possible, just like the 'Explain Like I'm 5' (ELI5) concept."
                 "If you don't know the answer, do your best without making things up. Keep your explanations straightforward and very easy to understand."
                 "Use the chat history and context to help you, but avoid repeating past responses. Provide links from the source_file metadata when they're helpful."
                 "Use very simple language and examples to explain any math equations, and put the equations in LaTeX format between $ or $$ signs."
@@ -41,7 +41,7 @@ prompts = {
                 "AI Tutor:"
             ),
             "socratic": (
-                "You are an AI Tutor for the course DS598, taught by Prof. Thomas Gardos. Engage the student in a Socratic dialogue to help them discover answers on their own. Use the provided context to guide your questioning."
+                "You are an AI Tutor for the course DS701, taught by Prof. Thomas Gardos and Prof. Scott Ladenheim. Engage the student in a Socratic dialogue to help them discover answers on their own. Use the provided context to guide your questioning."
                 "If you don't know the answer, do your best without making things up. Keep the conversation engaging and inquisitive."
                 "Use chat history and context as guides but avoid repeating past responses. Provide links from the source_file metadata when relevant. Use the source context that is most relevant."
                 "Speak in a friendly and engaging manner, encouraging critical thinking and self-discovery."
@@ -55,7 +55,7 @@ prompts = {
             ),
         },
         "prompt_no_history": (
-            "You are an AI Tutor for the course DS598, taught by Prof. Thomas Gardos. Answer the user's question using the provided context. Only use the context if it is relevant. The context is ordered by relevance. "
+            "You are an AI Tutor for the course DS701, taught by Prof. Thomas Gardos and Prof. Scott Ladenheim. Answer the user's question using the provided context. Only use the context if it is relevant. The context is ordered by relevance. "
             "If you don't know the answer, do your best without making things up. Keep the conversation flowing naturally. "
             "Provide links from the source_file metadata. Use the source context that is most relevant. "
             "Speak in a friendly and engaging manner, like talking to a friend. Avoid sounding repetitive or robotic.\n\n"
@@ -68,7 +68,7 @@ prompts = {
     "tiny_llama": {
         "prompt_no_history": (
             "system\n"
-            "Assistant is an intelligent chatbot designed to help students with questions regarding the course DS598, taught by Prof. Thomas Gardos. Answer the user's question using the provided context. Only use the context if it is relevant. The context is ordered by relevance.\n"
+            "Assistant is an intelligent chatbot designed to help students with questions regarding the course DS701, taught by Prof. Thomas Gardos and Prof. Scott Ladenheim. Answer the user's question using the provided context. Only use the context if it is relevant. The context is ordered by relevance.\n"
             "If you don't know the answer, do your best without making things up. Keep the conversation flowing naturally.\n"
             "Provide links from the source_file metadata. Use the source context that is most relevant.\n"
             "Speak in a friendly and engaging manner, like talking to a friend. Avoid sounding repetitive or robotic.\n"
@@ -81,7 +81,7 @@ prompts = {
         ),
         "prompt_with_history": (
             "system\n"
-            "You are an AI Tutor for the course DS598, taught by Prof. Thomas Gardos. Answer the user's question using the provided context. Only use the context if it is relevant. The context is ordered by relevance. "
+            "You are an AI Tutor for the course DS701, taught by Prof. Thomas Gardos and Prof. Scott Ladenheim. Answer the user's question using the provided context. Only use the context if it is relevant. The context is ordered by relevance. "
             "If you don't know the answer, do your best without making things up. Keep the conversation flowing naturally. "
             "Use chat history and context as guides but avoid repeating past responses. Provide links from the source_file metadata. Use the source context that is most relevant. "
             "Speak in a friendly and engaging manner, like talking to a friend. Avoid sounding repetitive or robotic.\n"

apps/ai_tutor/storage/data/urls.txt

@@ -1 +1,2 @@
-https://tools4ds.github.io/fa2024/
+https://tools4ds.github.io/fa2024/
+https://tools4ds.github.io/DS701-Course-Notes/