Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sd338/ai-math-genie
AI-Math-Genie is your intelligent assistant for quick, accurate math solutions. Using advanced LLM technology, simply enter any mathematical expression and get instant results. Easy to use and powered by AI, it simplifies complex calculations with ease.
https://github.com/sd338/ai-math-genie
ai calculations chatbot groq machine-learning math math-assistant nlp python ui
Last synced: 7 days ago
JSON representation
AI-Math-Genie is your intelligent assistant for quick, accurate math solutions. Using advanced LLM technology, simply enter any mathematical expression and get instant results. Easy to use and powered by AI, it simplifies complex calculations with ease.
- Host: GitHub
- URL: https://github.com/sd338/ai-math-genie
- Owner: sd338
- License: mit
- Created: 2024-07-23T15:33:36.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-24T08:01:21.000Z (4 months ago)
- Last Synced: 2024-07-24T18:28:24.752Z (4 months ago)
- Topics: ai, calculations, chatbot, groq, machine-learning, math, math-assistant, nlp, python, ui
- Language: Python
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AI Math Genie
**AI Math Genie** is an advanced math assistant that helps you with various mathematical problems. It uses the latest AI technology to give you accurate answers and explanations. This application provides an easy-to-use chat interface where you can type your questions and get instant results.
## Features
- **Interactive Chat Interface**: Communicate with the AI and get answers to your math queries in real-time.
- **User-Friendly Design**: A modern and attractive interface for a better user experience.
- **Customizable Styles**: Personalized chat messages to make interactions more engaging.
## Getting Started
### Prerequisites
1. **Python**: Ensure you have Python 3.7 or later installed on your computer. You can download Python from the [official website](https://www.python.org/downloads/).
2. **Git**: Make sure Git is installed on your computer for cloning the repository. You can download Git from the [official website](https://git-scm.com/downloads).
### Installation Steps
#### 1. Clone the Repository
First, you need to clone the project repository to your local machine. Open a terminal or command prompt and run the following command:
```bash
git clone https://github.com/sd338/AI-Math-Genie.git
```
This will create a folder named `AI-Math-Genie` with all the project files.
#### 2. Navigate to the Project Directory
Change to the project directory using the following command:
```bash
cd AI-Math-Genie
```
#### 3. Set Up a Virtual Environment (Recommended)
Creating a virtual environment helps manage project-specific dependencies. Run the following command to create and activate a virtual environment:
- **Windows**:
```bash
python -m venv env
.\env\Scripts\activate
```
- **Mac/Linux**:
```bash
python3 -m venv env
source env/bin/activate
```
#### 4. Install Dependencies
Install the required Python packages using `pip`. Run:
```bash
pip install -r requirements.txt
```
#### 5. Set Up Environment Variables
Create a `.env` file in the project directory with the following content:
```env
GROQ_API_KEY=your_groq_api_key_here
```
Replace `your_groq_api_key_here` with your actual API key from Groq.
## Running the Application
To start the application, use the following command:
```bash
python main.py
```
This will open the Math Genie GUI, where you can interact with the AI.
## Project Structure
- **`main.py`**: The main file that starts the application and shows the GUI.
- **`gui.py`**: Contains the code for the graphical user interface and chat functionality.
- **`calculator.py`**: Handles communication with the Groq API and processes mathematical queries.
- **`requirements.txt`**: Lists all the Python packages required for this project.
- **`.env`**: Configuration file for storing sensitive information like API keys.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
```
### License Information
```
MIT License
Copyright (c) 2024 Samanta Das
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
### Contact
For any questions or support, please connect with me on Twitter or LinkedIn. You can find links to these profiles on my GitHub profile.