Omnamdev02 commited on
Commit
328c284
Β·
1 Parent(s): a0ae5a7

Fix README metadata

Browse files
Files changed (1) hide show
  1. README.md +5 -81
README.md CHANGED
@@ -1,87 +1,11 @@
1
- <<<<<<< HEAD
2
- # AutoExamGen – AI Based Exam Question Generator
3
-
4
- AutoExamGen is an intelligent Python-based system that automatically generates exam questions
5
- (MCQ, short answer, and long answer) from input text using Natural Language Processing (NLP) techniques.
6
-
7
- ## Features
8
-
9
- - **Text Preprocessing**: Cleans and preprocesses input text using NLTK
10
- - **Keyword Extraction**: Identifies important concepts using RAKE algorithm
11
- - **Question Generation**: Uses HuggingFace T5 model to generate questions
12
- - **Option Generation**: Creates multiple-choice options with distractors
13
- - **Syllabus-Based Generation**: Generate questions topic-wise from syllabus input
14
- - **Download Support**: Export generated question papers
15
- - **Multiple Interfaces**: CLI and Web interface (Flask) support
16
- - **JSON Output**: Structured output format for easy integration
17
-
18
- ## Installation
19
-
20
- 1. Clone or download this project
21
- 2. Install dependencies:
22
- ```bash
23
- pip install -r requirements.txt
24
- ```
25
-
26
- 3. Download required NLTK data (run once):
27
- ```bash
28
- python setup_nltk.py
29
-
30
- ## Usage
31
-
32
- ### Web Interface
33
- The web interface allows users to upload text or documents and configure question types and difficulty.
34
-
35
- python app.py
36
- ```
37
- Then open http://localhost:5000 in your browser.
38
-
39
- ### Python API
40
- ```python
41
- from question_generator import QuestionGenerator
42
-
43
- generator = QuestionGenerator()
44
- questions = generator.generate_questions("Your input text here")
45
- ```
46
-
47
- ## Project Structure
48
-
49
- - `app.py` – Flask web application (main entry point)
50
- - `exam_question_system.py` – Orchestrates the complete question generation pipeline
51
- - `question_generator.py` – Core question generation logic
52
- - `text_processor.py` – Text cleaning and preprocessing
53
- - `keyword_extractor.py` – Keyword and concept extraction (RAKE)
54
- - `option_generator.py` – MCQ option and distractor generation
55
- - `syllabus_processor.py` – Syllabus-based question generation
56
- - `local_question_generator.py` – Transformer-based (T5) question generator
57
- - `setup_nltk.py` – NLTK data setup script
58
-
59
- ## Technologies Used
60
-
61
- - Python
62
- - Flask
63
- - Natural Language Processing (NLP)
64
- - NLTK
65
- - RAKE Algorithm
66
- - HuggingFace Transformers (T5)
67
- - HTML, CSS (Web Interface)
68
- ## Author
69
-
70
-
71
- **Om Namdev**
72
- B.Tech AI & DS
73
- Aspiring Data Scientist
74
- =======
75
  ---
76
  title: AutoExamGen
77
- emoji: 🐒
78
- colorFrom: purple
79
- colorTo: red
80
  sdk: docker
81
  pinned: false
82
- license: mit
83
- short_description: AutoExamGen is an AI-powered system.
84
  ---
85
 
86
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
87
- >>>>>>> a56473e9e57932ec6018faca9490a4b3cda36e15
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: AutoExamGen
3
+ emoji: πŸ“
4
+ colorFrom: blue
5
+ colorTo: green
6
  sdk: docker
7
  pinned: false
 
 
8
  ---
9
 
10
+ # AutoExamGen
11
+ AI-powered exam question generator using NLP and HuggingFace T5 model.