├── .DS_Store ├── .gitignore ├── AL ZEBRA.png ├── LICENSE ├── README.md ├── requirements.txt ├── server.py └── templates └── chat.html /.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moreshk/alzebra/075f301a026438cff36578962e4ec6fb99559002/.DS_Store -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | -------------------------------------------------------------------------------- /AL ZEBRA.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/moreshk/alzebra/075f301a026438cff36578962e4ec6fb99559002/AL ZEBRA.png -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 moreshk 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Al Zebra: AI-Powered Maths Tutor for Kids 2 | 3 | ![Alt text]() 4 | 5 | Al Zebra is an AI-powered maths tutor designed to provide interactive learning experiences for kids. It helps kids with mathematics by posing problems of increasing complexity based on their previous responses, verifying their answers, and providing step-by-step explanations for correct solutions. 6 | 7 | ## Features 8 | 9 | - Intelligent progression of problem complexity based on learner performance 10 | - Explanation of correct answers in a step-by-step manner 11 | - Interactive and engaging learning experience 12 | 13 | ## Installation 14 | 15 | ### Prerequisites 16 | 17 | - Python 3.7+ 18 | - pip 19 | 20 | ### Setup 21 | 22 | 1. Clone the repository: 23 | 24 | ```sh 25 | git clone https://github.com/moreshk/alzebra.git 26 | cd alzebra 27 | ``` 28 | 29 | 2. Install the necessary dependencies: 30 | 31 | ```sh 32 | pip install -r requirements.txt 33 | ``` 34 | 35 | 3. Run the application: 36 | 37 | ```sh 38 | python server.py 39 | ``` 40 | 41 | Then, open your web browser and navigate to `localhost:5000`. 42 | 43 | ## Usage 44 | 45 | Start by inputting your message to Al Zebra in the provided text box. Al Zebra will then respond with a mathematical problem. Enter your answer in the text box and Al Zebra will validate it, providing a step-by-step explanation if the answer is incorrect. 46 | 47 | ## Tech Stack 48 | 49 | - Flask: Web server 50 | - OpenAI: AI model 51 | - LangChain: Library for chaining different language models 52 | - Bootstrap: Front-end component library 53 | 54 | ## Contributing 55 | 56 | Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute. 57 | 58 | ## License 59 | 60 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details 61 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Flask==2.2.3 2 | openai==0.27.0 3 | requests==2.28.2 4 | python-dotenv==0.19.1 -------------------------------------------------------------------------------- /server.py: -------------------------------------------------------------------------------- 1 | from flask import Flask, render_template, request, session 2 | from dotenv import load_dotenv 3 | import os 4 | 5 | # Load environment variables from the .env file 6 | load_dotenv() 7 | 8 | # The rest of your imports here 9 | from langchain.agents import Tool 10 | from langchain.agents import AgentType 11 | from langchain.memory import ConversationBufferMemory 12 | from langchain import OpenAI 13 | from langchain.utilities import GoogleSearchAPIWrapper 14 | from langchain.agents import initialize_agent 15 | from langchain import LLMMathChain 16 | 17 | # Setting up the chatbot 18 | llm = OpenAI(temperature=0) 19 | llm_math_chain = LLMMathChain.from_llm(llm=llm, verbose=True) 20 | 21 | tools = [ 22 | Tool( 23 | name="Calculator", 24 | func=llm_math_chain.run, 25 | description="must use for when you need to answer questions about math", 26 | return_direct = True 27 | ), 28 | ] 29 | 30 | memory = ConversationBufferMemory(memory_key="chat_history") 31 | memory.save_context({'user': 'You are role is a math tutor called Al Zebra and your objective is to teach a 7 year old kid division. You will pose math questions of this nature and see if the response from the kid about the quotient and remainder was correct. If it is correct you congratulate the kid and provide the next problem which should have a increasingly higher complexity. If the answer is wrong tell the correct answer and explain how you arrived at the correct answer step by step. Start with simple problems and go to more complex questions if the user responds with correct answers. If the answer given was incorrect reduce the complexity of your next question. Note that you will restrict yourself only to posing the questions, verifying their answers, and providing explanations of how you arrived at the correct answer. Dont ask if the kid is ready for the next problem, simply post the next problem as soon as the opportunity arises. The childs responses will be provided by me. Begin the conversation by asking the user their name and if they are ready to learn Maths. Do not forget that you are supposed to teach substraction only. Continue this problem answer loop till the user asks to stop or the user gets 3 answers wrong in a row. You must always use a tool to generate a response related to a maths question.'}, {'bot': 'Got it, I am ready to start acting as a Maths tutor.'}) 32 | llm=OpenAI(temperature=0) 33 | agent_chain = initialize_agent(tools, llm, agent=AgentType.CONVERSATIONAL_REACT_DESCRIPTION, verbose=True, memory=memory) 34 | 35 | app = Flask(__name__) 36 | app.secret_key = '1234' # It's better to use a random value 37 | 38 | @app.route('/', methods=['GET', 'POST']) 39 | def chat(): 40 | if request.method == 'POST': 41 | if 'clear' in request.form: 42 | session['chat_history'] = [] # Clear the chat history from the session 43 | else: 44 | user_input = request.form.get('message') 45 | bot_response = agent_chain.run(user_input) # Using the chatbot here 46 | session['chat_history'].append({'user': user_input, 'bot': bot_response}) 47 | session.modified = True 48 | else: 49 | if 'chat_history' not in session: 50 | session['chat_history'] = [] 51 | 52 | return render_template('chat.html', chat_history=session['chat_history']) 53 | 54 | if __name__ == '__main__': 55 | app.run(debug=True) 56 | -------------------------------------------------------------------------------- /templates/chat.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 33 | 34 | 35 |
36 |

Al Zebra: AI powered Maths tutor for kids

37 | 38 |
39 |
40 |
41 | 42 |
43 | 44 | 47 |
48 | 49 |
50 | {% for exchange in chat_history|reverse %} 51 |
52 |

You: {{ exchange.user }}

53 |

Bot: {{ exchange.bot }}

54 |
55 | {% endfor %} 56 |
57 |
58 | 59 | --------------------------------------------------------------------------------