Skip to content

Commit 32c8c59

Browse files
committed
2 parents f1135b2 + b01b274 commit 32c8c59

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AI Math Notes
2+
![AI-Math-Notes](https://github.com/ayushpai/AI-Math-Notes/assets/43297680/b2a2b0ce-5d1b-4639-8549-4f2725eb4c28)
3+
4+
AI Math Notes is an interactive drawing application that allows users to draw mathematical equations on a canvas. Once an equation is drawn, the application uses a multimodal LLM to calculate and display the result next to the equals sign. The application is built using Python with the Tkinter library for the graphical user interface and PIL for image processing. Inspired by Apple's ["Math Notes" demo](https://www.youtube.com/live/RXeOiIDNNek?si=zsfLkfVtCoCqk1ie&t=2806) from WWDC 2024.
5+
6+
7+
## Setup & Installation
8+
- Install libraries: `pip install -r requirements.txt`
9+
- Setup OpenAI API as enviorment variable
10+
11+
12+
## Usage
13+
- Run the application: `python app.py`
14+
### Application Interface
15+
16+
The app works by placing the answer next to an equation that has not been solved (AKA an equals sign with nothing to the right of it). An equals sign must be the last thing you wrote before clicking calculate.
17+
18+
- Canvas: Draw equations using your mouse. The canvas background is black, and the drawing color is white.
19+
- Clear Button: Clears the entire canvas.
20+
- Undo Button (Ctrl/Cmd Z): Undoes the last drawing action
21+
- Calculate Button (Enter/Return): Calculates the drawn equation and displays the result next to the equals sign.
22+
23+
### Example
24+
- Draw an equation on the canvas, such as `5 + 3 =`
25+
- Press Enter or click the Calculate button.
26+
- The result (e.g., 8) will be displayed next to the equals sign in orange color.
27+
28+
## Future Improvements
29+
- Auto-detect Equals Sign: Implement a computer vision model to detect the equals sign so that it doesn't have to be the last thing you drew. This will improve usability and accuracy in placing the answer.
30+
- Any contributions are welcome!
31+
32+
## License
33+
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)