Skip to content

gisketch/ZELDA-cs50-final-project

Repository files navigation

🧝 Zelda: A GPT-3 Powered Natural Language Mathematical Expression Parser

Zelda is a natural language mathematical expression parser powered by OpenAI's GPT-3 language model. The application is built in JavaScript and ReactJS.

Description:

Hey everyone, I'm thrilled to share with you my latest creation called ZELDA! As a recent college graduate and a hobbyist in the world of software development, I wanted to make math more accessible and fun for everyone, especially those who struggle with word problems and mathematical expressions. That's why I've designed ZELDA, a powerful software application that utilizes the cutting-edge technology of GPT-3 to parse and understand natural language math expressions.

So, what does ZELDA do? Well, imagine being able to type in a math problem using simple, everyday language, and instantly getting a mathematical expression in Latex format as the output. With ZELDA, you don't have to worry about translating confusing word problems into equations anymore. It takes your input and magically transforms it into a concise mathematical expression that you can easily understand and work with.

But ZELDA goes beyond just solving math problems. It's built with the belief that a safe and supportive learning environment is crucial for students to thrive. That's why I've incorporated features that promote conceptual learning and critical thinking. By understanding the underlying concepts of math, users can grasp new ideas and solve problems more effectively.

With ZELDA, learning math becomes an interactive and engaging experience. You can explore various mathematical concepts, evaluate your own understanding, and even challenge yourself with complex problems. The software provides a positive and encouraging atmosphere where users can take risks, explore new ideas, and grow their mathematical abilities.

I've poured my heart and soul into creating ZELDA because I believe that understanding math shouldn't be a struggle. It should be accessible, enjoyable, and empowering for everyone. By leveraging the power of GPT-3, ZELDA aims to bridge the gap between natural language and mathematical expressions, making math more approachable and exciting.

So, whether you're a student looking to improve your math skills or an adult who wants to refresh your knowledge, ZELDA is here to assist you on your mathematical journey. Give it a try, and let me know what you think! I'm constantly working on enhancing the accuracy and functionality of ZELDA, and your feedback will be invaluable in shaping its future.

Remember, math is not just about numbers and formulas. It's about understanding, problem-solving, and embracing the beauty of logic. Let ZELDA be your guide in unlocking the wonders of mathematics with simplicity and joy.

Disclaimer: ZELDA is a passion project created by me, and while it strives to provide accurate and reliable results, it is always advisable to double-check the generated expressions for mathematical correctness.

✨ Features

Zelda can:

  • Explain primary school mathematical word problems by converting and parsing them into mathematical expressions.
  • Show the step by step process.
  • Zelda is not accurate at solving mathematics, so she will never answer the equations. Only show how the operations were parsed from the word problem.
🛠️ Installation

To install and run Zelda, you will need:

  • Node.js and npm installed on your Raspberry Pi.
  • An OpenAI API key for GPT-3.
  • A microphone and a speaker

To install Zelda, follow these steps:

  1. Clone the repository: git clone https://github.com/gisketch/ZELDA-math-parser
  2. Navigate to the project directory: cd ZELDA-math-parser
  3. Install the dependencies: npm install
  4. Set up your OpenAI API key as an environment variable (create a .env file): VITE_OPENAI_API_KEY=YOUR KEY HERE
  5. Start the application: npm run dev
🚀 Usage
  1. Enter your name so that Zelda will know who she's talking to! 👋

image

  1. Press the record button to ask Zelda any math problems! 🎤

image

  1. Voila! 🎉

image

🤝 Contributing

Contributions to Zelda are welcome! If you want to contribute:

  1. Fork the repository.
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your changes and commit them: git commit -m "My commit message"
  4. Push your changes to your fork: git push origin my-branch-name
  5. Create a pull request.
🙏 Acknowledgements

Zelda was created by Ghegi Jimenez as part of his cs50 final project with the help of OpenAI's GPT-3 language model. Special thanks to my friends who supported me throughout all the hardships I've faced creating this project. You know who you are. ❤️

About

Ghegi Jimenez' final project for cs50x

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages