QuizCraftAi / README.md
Aditi
Add space configuration to README
2eef3a3
---
title: QuizCraftAi
emoji: 🧠
colorFrom: pink
colorTo: purple
sdk: streamlit
sdk_version: "1.32.0"
app_file: app.py
pinned: false
---
# πŸ“šAI-Powered Custom Quiz Generator - QuizCraft Ai
Generate personalized MCQs, short answer, and true/false questions using Hugging Face Transformers and a Streamlit UI.
## πŸ’‘ Features
- Question generator (MCQ, short answer, true/false)
- Streamlit-based frontend
- Cosine Similarity, BLEU-1, ROUGE -1 AND ROUGE-L Evaluation
- Fine-tuned FLAN-T5 integration
- Customization: Select topic, difficulty, and number of questions
## πŸš€ How to Run
```bash
git clone https://github.com/YOUR_USERNAME/custom-quiz-generator.git
cd custom-quiz-generator
# (Optional) Create virtual environment
python -m venv venv
source venv/Scripts/activate # On Windows
# or
source venv/bin/activate # On Mac/Linux
# Install required dependencies
pip install -r requirements.txt
# Run the app
streamlit run app.py
```
## Repo Struture
```
custom-quiz-generator/
β”‚
β”œβ”€β”€ app.py # Streamlit UI
β”œβ”€β”€ fine_tune_and_evaluation.py # Fine-tuning & evaluation script
β”œβ”€β”€ flan_t5_finetuned_model/ # Directory storing the fine-tuned FLAN-T5 model
β”œβ”€β”€ mcq_generator.py # MCQ generation script
β”œβ”€β”€ quiz_logic.py # Core quiz generation logic
β”œβ”€β”€ short_answer_generator.py # Script for short answer generation
β”œβ”€β”€ truefalse_quiz.py # True/False question generator
β”œβ”€β”€ train_v0.2_QuaC.json # Training dataset
β”œβ”€β”€ outputs/ # Stores generated questions/outputs
β”œβ”€β”€ valhalla/ # T5-based fine-tuned models
β”œβ”€β”€ requirements.txt # Project dependencies
β”œβ”€β”€ FineTuneAndEvaluationscores.ipynb # Evaluation notebook
β”œβ”€β”€ README.md # Project documentation
└── .gitignore # Git ignore rules
```