NanthagopalEswaran / QA_Generator

Generate Quiz from documents using AI

📚 QA Generator - Your Personal Quizmaster

🎉 Welcome Aboard

Welcome to the QA Generator, a free and open-source AI tool that transforms your documents into quizzes in a matter of minutes. From simple quizzes to full-blown mock exam papers, we've got you covered!

🎁 What's in the Box?

• Document Upload: We support document uploads in "pdf", "docx", "md", "txt", "rst" formats up to 20MB. Leverage our platform to transform your documents into quizzes.
• Customized QA Generation: Exercise full control over your quiz creation. Define the number of questions, their types, and difficulty levels to suit your needs.
• Answer Generation: Choose to generate answers for each question. This feature is designed to facilitate the later evaluation of participants' responses, providing a benchmark for comparison.

🚀 Quick Access

Jump straight into the action with our QA Generator! It's publicly accessible and ready for you to try out.

🔗 Click here to access the QA Generator Space

🚀 Installation

Here's how you can get the project up and running on your local machine for development and testing:

Prerequisites

• Python 3.7 or later
• Poetry for managing dependencies

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/NanthagopalEswaran/QA_Generator.git

2. Install the dependencies using Poetry:

   poetry install

Fire Up the Application

Start the Streamlit app with this command:

poetry run streamlit run app.py

The app will spring to life in your default web browser.

1. Upload a document (maximum file size: 20MB). We support "pdf", "docx", "md", "txt", "rst" formats.
2. Specify the number of questions you wish to generate.
3. Select the type of questions and provide the necessary details.
4. Decide if you want to generate answers as well.
5. Click 'Generate' to start the QA generation process.

Once the process is complete, you'll be presented with your freshly minted questions and their respective answers.

Heads Up: We currently do not support images in the document.

🤝 Contributions

We welcome contributions from everyone. Here's how you can pitch in:

1. Fork the repository on GitHub.
2. Clone the forked repository to your local machine.
3. Make your changes and commit them with a meaningful message.
4. Push the changes to your forked GitHub repository.
5. Submit a pull request to our repository.

For more detailed instructions, check out the GitHub Docs.

📜 License

QA Generator is licensed under the MIT License. For more details, see the LICENSE file.

📞 Connect With Us

Got questions? Encountered issues? Or just want to drop a friendly hello? We're all ears!

• Email: Feel free to shoot us an email at [e-mail].
• Issue Tracker: Stumbled upon a bug or have a feature request? Head over to our Issues Tracker on GitHub and let us know. Your feedback helps us improve!