Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mubassim-khan/quizmaster-ai
This repository contains the code of Quiz Generating AI app made using GPT-4o, Streamlit, LangChain & Python. View README for more descriptive overview of repository.
https://github.com/mubassim-khan/quizmaster-ai
gpt4o langchain langchain-python python-3 quiz-generator streamlit
Last synced: 29 days ago
JSON representation
This repository contains the code of Quiz Generating AI app made using GPT-4o, Streamlit, LangChain & Python. View README for more descriptive overview of repository.
- Host: GitHub
- URL: https://github.com/mubassim-khan/quizmaster-ai
- Owner: Mubassim-Khan
- License: mit
- Created: 2024-09-05T17:13:52.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-09-06T21:36:03.000Z (2 months ago)
- Last Synced: 2024-10-01T19:27:12.383Z (about 2 months ago)
- Topics: gpt4o, langchain, langchain-python, python-3, quiz-generator, streamlit
- Language: Python
- Homepage: https://quizmaster-ai.streamlit.app/
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QuizMaster AI
## 📋 Table of Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Tech Stack](#tech-stack)
4. [Getting Started](#quick-start)
5. [License](#license)
6. [Contributing](#contributing)
7. [Acknowledgements](#acknowledgements)
8. [Contact](#contact)
## Introduction
This repository contains the code of an AI app, which is able to generate MCQs quiz, based on the data, difficulty & subject provided by the user. The AI Model is fine-trained & is made on top of GPT-4o & LangChain. The UI is made using Streamlit. This AI application is helpful for eduactional purposes, resulting in increase of knowledge, in particular domain.
## Features
👉 **MCQ Generation from Documents**: Users can upload PDF or text files, and the app generates multiple-choice questions (MCQs) based on the content using GPT-4.
👉 **Customizable Question Count**: Users can specify the number of MCQs they want to generate from the document.
👉 **Subject and Tone Selection**: Users can provide the subject and specify the complexity level of the questions for tailored quiz generation.
👉 **Automatic Quiz Table**: Generated MCQs are automatically displayed in a table format using Pandas, allowing users to easily review and analyze them.
👉 **Detailed Review Section**: The app generates a review of the MCQs, assessing the complexity and providing feedback.
👉 **PDF and Text File Support**: Users can upload both PDF and text files as input for quiz generation.
👉 **Streamlined Interface**: Built with Streamlit, the app provides a user-friendly interface for easy navigation and interaction.
👉 **Real-time Cost & Token Usage Monitoring**: Displays token usage and cost of the API call to OpenAI, ensuring transparency for users.
- [Python](https://www.python.org/) - Programming Language
- [LangChain](https://www.langchain.com/) - LLM Framework
- [GPT-4o](https://openai.com/index/hello-gpt-4o/) - OpenAI Model
- [Streamlit](https://streamlit.io/) - Python Framework
To get started with this project, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/Mubassim-Khan/QuizMaster-AI.git
```
2. Open the project in your preferred code editor.
3. Create a virtual environment of suitable python version using:
```bash
conda create -p venv python=3.x -y`
```
4. Activate environment using:
```bash
`source activate ./venv` or `conda activate ./venv`
```
5. Install the project dependencies using pip:
```bash
pip install -r requirements.txt
```
6. Set Up Environment Variables by creating a new file named `.env` in the root of your project and add the following variables:
```env
OPENAI_API_KEY="your credentials"
```
7. Run the project
```bash
`streamlit run StreamlitApp.py` or `python -m streamlit run StreamlitApp.py`
```
8. Open [http://localhost:8501](http://localhost:8501) to view it in your browser.
## License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
## Contributing
Contributions to this project are welcome. If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
- Copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
## Contact
If you have any questions, suggestions, or feedback, you can reach out to the project maintainer:
- LinkedIn : [Mubassim Ahmed Khan](https://www.linkedin.com/in/mubassim)
- Email: [[email protected]](mailto:[email protected])
---