Farid Karimli
commited on
Commit
·
9e7bc3d
1
Parent(s):
ccca716
Started retarget process
Browse files- README.md +46 -5
- apps/ai_tutor/.chainlit/config.toml +3 -3
- apps/ai_tutor/app.py +1 -1
- apps/ai_tutor/public/assets/images/avatars/ai-tutor.png +0 -0
- apps/ai_tutor/public/assets/images/avatars/ai_tutor.png +0 -0
- apps/ai_tutor/public/files/test.css +23 -22
- apps/ai_tutor/public/logo_dark.png +0 -0
- apps/ai_tutor/public/logo_light.png +0 -0
- apps/ai_tutor/storage/data/urls.txt +1 -1
README.md
CHANGED
@@ -1,7 +1,48 @@
|
|
1 |
-
|
2 |
|
3 |
-
|
4 |
-
pip install edubotics-core
|
5 |
-
```
|
6 |
|
7 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# DS701: Tools for Data Science - Education Chatbot
|
2 |
|
3 |
+
## Overview
|
|
|
|
|
4 |
|
5 |
+
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.
|
6 |
+
|
7 |
+
## Features
|
8 |
+
|
9 |
+
- 24/7 availability for student queries
|
10 |
+
- Explanations of key data science concepts
|
11 |
+
- Guidance on using data science tools and libraries
|
12 |
+
- Practice problem suggestions and explanations
|
13 |
+
- Course syllabus and schedule information
|
14 |
+
|
15 |
+
## Getting Started
|
16 |
+
|
17 |
+
To use the chatbot, follow these steps:
|
18 |
+
|
19 |
+
1. Clone this repository
|
20 |
+
2. Install the required dependencies (see `requirements.txt`)
|
21 |
+
3. Set up the necessary environment variables (see `.env.example`)
|
22 |
+
4. Run the chatbot application
|
23 |
+
|
24 |
+
## Usage
|
25 |
+
|
26 |
+
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.
|
27 |
+
|
28 |
+
Example queries:
|
29 |
+
|
30 |
+
- "Explain the concept of data normalization"
|
31 |
+
- "How do I use pandas for data manipulation?"
|
32 |
+
- "What's the difference between supervised and unsupervised learning?"
|
33 |
+
|
34 |
+
## Contributing
|
35 |
+
|
36 |
+
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.
|
37 |
+
|
38 |
+
## Privacy and Data Handling
|
39 |
+
|
40 |
+
This chatbot is designed with student privacy in mind. No personal information is stored, and all interactions are anonymized. For more details, please refer to our `PRIVACY_POLICY.md`.
|
41 |
+
|
42 |
+
## Support
|
43 |
+
|
44 |
+
If you encounter any issues or have suggestions for improvement, please open an issue in this repository or contact the course instructor.
|
45 |
+
|
46 |
+
## License
|
47 |
+
|
48 |
+
This project is licensed under the MIT License - see the `LICENSE.md` file for details.
|
apps/ai_tutor/.chainlit/config.toml
CHANGED
@@ -53,10 +53,10 @@ edit_message = true
|
|
53 |
|
54 |
[UI]
|
55 |
# Name of the assistant.
|
56 |
-
name = "AI Tutor"
|
57 |
|
58 |
# Description of the assistant. This is used for HTML tags.
|
59 |
-
|
60 |
|
61 |
# Large size content are by default collapsed for a cleaner ui
|
62 |
default_collapse_content = true
|
@@ -65,7 +65,7 @@ default_collapse_content = true
|
|
65 |
cot = "hidden"
|
66 |
|
67 |
# Link to your github repo. This will add a github button in the UI's header.
|
68 |
-
github = "https://github.com/
|
69 |
|
70 |
# Specify a CSS file that can be used to customize the user interface.
|
71 |
# The CSS file can be served from the public directory or via an external link.
|
|
|
53 |
|
54 |
[UI]
|
55 |
# Name of the assistant.
|
56 |
+
name = "DS701 AI Tutor"
|
57 |
|
58 |
# Description of the assistant. This is used for HTML tags.
|
59 |
+
description = "Your AI tutor for DS701: Tools for Data Science. Here to assist you with course content, answer questions, and provide guidance on data science concepts."
|
60 |
|
61 |
# Large size content are by default collapsed for a cleaner ui
|
62 |
default_collapse_content = true
|
|
|
65 |
cot = "hidden"
|
66 |
|
67 |
# Link to your github repo. This will add a github button in the UI's header.
|
68 |
+
github = "https://github.com/tools4ds/ds701-tutor"
|
69 |
|
70 |
# Specify a CSS file that can be used to customize the user interface.
|
71 |
# The CSS file can be served from the public directory or via an external link.
|
apps/ai_tutor/app.py
CHANGED
@@ -387,4 +387,4 @@ mount_chainlit(app=app, target="chainlit_app.py", path=CHAINLIT_PATH)
|
|
387 |
if __name__ == "__main__":
|
388 |
import uvicorn
|
389 |
|
390 |
-
uvicorn.run(app, host="127.0.0.1", port=
|
|
|
387 |
if __name__ == "__main__":
|
388 |
import uvicorn
|
389 |
|
390 |
+
uvicorn.run(app, host="127.0.0.1", port=8000)
|
apps/ai_tutor/public/assets/images/avatars/ai-tutor.png
DELETED
Binary file (169 kB)
|
|
apps/ai_tutor/public/assets/images/avatars/ai_tutor.png
DELETED
Binary file (169 kB)
|
|
apps/ai_tutor/public/files/test.css
CHANGED
@@ -1,32 +1,33 @@
|
|
1 |
-
a[href*='https://github.com/Chainlit/chainlit']
|
2 |
-
|
|
|
3 |
}
|
4 |
|
5 |
-
/* Hide the default avatar image */
|
6 |
.MuiAvatar-root img.MuiAvatar-img {
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
/* Target the container of the image and set a custom background image */
|
11 |
.MuiAvatar-root.MuiAvatar-circular.css-m2icte {
|
12 |
-
|
13 |
-
|
14 |
-
|
15 |
-
|
16 |
-
|
17 |
-
|
18 |
}
|
19 |
.MuiAvatar-root.MuiAvatar-circular.css-v72an7 {
|
20 |
-
|
21 |
-
|
22 |
-
|
23 |
-
|
24 |
-
|
25 |
-
|
26 |
}
|
27 |
|
28 |
.MuiStack-root.css-14k6mw7 img {
|
29 |
-
|
30 |
-
|
31 |
-
|
32 |
-
}
|
|
|
1 |
+
a[href*='https://github.com/Chainlit/chainlit']
|
2 |
+
{
|
3 |
+
visibility: hidden;
|
4 |
}
|
5 |
|
6 |
+
/* Hide the default avatar image */
|
7 |
.MuiAvatar-root img.MuiAvatar-img {
|
8 |
+
display: none;
|
9 |
+
}
|
10 |
+
|
11 |
/* Target the container of the image and set a custom background image */
|
12 |
.MuiAvatar-root.MuiAvatar-circular.css-m2icte {
|
13 |
+
background-image: url("/public/assets/images/avatars/logo.png"); /* Replace with your custom image URL */
|
14 |
+
background-size: cover; /* Ensure the image covers the entire container */
|
15 |
+
background-position: center; /* Center the image */
|
16 |
+
width: 100px; /* Ensure the dimensions match the original */
|
17 |
+
height: 100px; /* Ensure the dimensions match the original */
|
18 |
+
border-radius: 50%; /* Maintain circular shape */
|
19 |
}
|
20 |
.MuiAvatar-root.MuiAvatar-circular.css-v72an7 {
|
21 |
+
background-image: url("/public/assets/images/avatars/logo.png"); /* Replace with your custom image URL */
|
22 |
+
background-size: cover; /* Ensure the image covers the entire container */
|
23 |
+
background-position: center; /* Center the image */
|
24 |
+
width: 40px; /* Ensure the dimensions match the original */
|
25 |
+
height: 40px; /* Ensure the dimensions match the original */
|
26 |
+
border-radius: 50%; /* Maintain circular shape */
|
27 |
}
|
28 |
|
29 |
.MuiStack-root.css-14k6mw7 img {
|
30 |
+
content: url("/public/assets/images/avatars/logo.png"); /* Replace with the path to your custom image */
|
31 |
+
max-height: 45px; /* Ensure the height remains consistent */
|
32 |
+
max-width: 45px; /* Ensure the width remains consistent */
|
33 |
+
}
|
apps/ai_tutor/public/logo_dark.png
CHANGED
apps/ai_tutor/public/logo_light.png
CHANGED
apps/ai_tutor/storage/data/urls.txt
CHANGED
@@ -1 +1 @@
|
|
1 |
-
https://
|
|
|
1 |
+
https://tools4ds.github.io/fa2024/
|