Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeeshanahmad4/quantumphysicsbot-a-discord-bot-for-high-school-physics
🌌 QuantumPhysicsBot: An AI-powered Discord bot that tutors high school students in physics with a conversational touch. 📘🤖
https://github.com/zeeshanahmad4/quantumphysicsbot-a-discord-bot-for-high-school-physics
ai chatbot discord-bot education gpt-4 image-interpretation llm quantumphysicsbot socratic-method tutoring
Last synced: 12 days ago
JSON representation
🌌 QuantumPhysicsBot: An AI-powered Discord bot that tutors high school students in physics with a conversational touch. 📘🤖
- Host: GitHub
- URL: https://github.com/zeeshanahmad4/quantumphysicsbot-a-discord-bot-for-high-school-physics
- Owner: Zeeshanahmad4
- Created: 2023-08-31T08:38:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-04T13:27:39.000Z (over 1 year ago)
- Last Synced: 2024-12-14T12:16:05.509Z (2 months ago)
- Topics: ai, chatbot, discord-bot, education, gpt-4, image-interpretation, llm, quantumphysicsbot, socratic-method, tutoring
- Language: Python
- Homepage:
- Size: 81.1 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🌌 QuantumPhysicsBot: A Discord Bot for High School Physics
[email protected]
┃
@zeeshanahmad4
┃
zee#2655
┃
Zeeshan Ahmad
For discussion, queries, and freelance work. Do reach me.👆👆👆
## Table of Contents
- [Project Overview](#project-overview-)
- [Features](#features-)
- [Future Enhancements (To-Do)](#future-enhancements-to-do-)
- [Usage Examples](#usage-examples-)
- [Setup and Installation Instructions](#setup-and-installation-instructions-)
- [Troubleshooting Tips](#troubleshooting-tips-)
- [Contribution Guidelines](#contribution-guidelines-)
## Project Overview 🌍
**QuantumPhysicsBot** is a friendly Discord bot designed to assist high school students with their physics questions. It harnesses the power of advanced language models to provide informative and conversational responses, all while following the Socratic method. Dive into the world of physics with your own AI-powered tutor!
### Features 🚀
- **Integration with LLM**: Uses advanced Language Learning Models like GPT-4 to generate accurate responses.
- **Image Interpretation**: Capable of understanding and answering questions based on diagrams or images.
- **Performance Analysis**: Measures the bot's responses against sample answers to ensure accuracy.
- **Custom Knowledge Base**: Allows for the addition of custom Q&A pairs to train and guide the bot.
- **Admin Panel**: View statistics related to LLM usage, and monitor the running costs of API calls.
#### Future Enhancements (To-Do) 🛠
- **Voice Integration**: Allow the bot to answer queries via voice on Discord.
- **Subject Expansion**: Extend the bot's capabilities to other subjects like Chemistry and Math.
- **Multilanguage Support**: Enable the bot to answer in multiple languages.
- **Interactive Learning**: Integrate quizzes and interactive learning modules.
## Usage Examples 🧪
``` !ask How does Newton's third law work?
!ask [Attach an Image] Can you explain this physics diagram?
```
## Setup and Installation Instructions 🖥
Clone the GitHub repository:
```git clone [repository-link]```
Navigate to the project directory:
```cd QuantumPhysicsBot```
Install required dependencies:
```pip install -r requirements.txt```
Run the bot:
```python discord_bot/bot.py```
### Troubleshooting Tips 🛠
- Ensure you've installed all dependencies.
- Check if your Discord token is correctly placed in `bot.py`.
- If the bot doesn't respond, ensure it has the necessary permissions in the Discord server.
### Contribution Guidelines 🤝
Contributions are always welcome! Here's how you can help:
- Fork the project.
- Create your feature branch: `git checkout -b feature/AmazingFeature`
- Commit your changes: `git commit -m 'Add some AmazingFeature'`
- Push to the branch: `git push origin feature/AmazingFeature`
- Open a pull request.