flanara commited on
Commit
63d5b01
·
verified ·
1 Parent(s): 75e4c5a

Upload folder using huggingface_hub

Browse files
Files changed (3) hide show
  1. README.md +170 -120
  2. adapter_config.json +2 -2
  3. adapter_model.safetensors +1 -1
README.md CHANGED
@@ -3,155 +3,205 @@ base_model: microsoft/phi-2
3
  library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
- - physics
7
- - education
8
- - mcq
9
- - question-generation
10
- - entrance-exam
11
- - cognitive-skills
12
- - bloom-taxonomy
13
  - lora
14
  - transformers
15
  ---
16
 
17
- # Physics MCQ Generator
 
 
 
18
 
19
- A fine-tuned language model that generates high-quality physics multiple-choice questions for university entrance exam preparation with customizable cognitive skill levels based on Bloom's Taxonomy.
20
 
21
  ## Model Details
22
 
23
  ### Model Description
24
 
25
- This model is specifically designed to generate competitive physics multiple-choice questions with accurate content, plausible distractors, and appropriate difficulty levels for entrance exam preparation. It supports four cognitive skill levels (Recall, Application, Analysis, Evaluation) and excels across major physics domains including mechanics, electromagnetism, thermodynamics, optics, and modern physics.
 
 
 
 
 
 
 
 
 
 
26
 
27
- - **Developed by:** [Your Name/Organization]
28
- - **Model type:** Fine-tuned Causal Language Model
29
- - **Language(s) (NLP):** English
30
- - **License:** MIT
31
- - **Finetuned from model:** microsoft/phi-2
32
 
33
- ### Model Sources
34
 
35
- - **Repository:** https://huggingface.co/your_username/physics-mcq-generator
36
- - **Demo:** [Available as Hugging Face Space]
 
37
 
38
  ## Uses
39
 
 
 
40
  ### Direct Use
41
 
42
- This model is intended for direct use in generating physics multiple-choice questions for:
43
- - University entrance exam preparation with varying cognitive levels
44
- - Differentiated instruction materials
45
- - Bloom's Taxonomy-aligned assessment creation
46
- - Educational content creation across cognitive domains
47
- - Tutoring and teaching assistance with skill-based questioning
48
 
49
- ### Downstream Use
50
 
51
- The model can be integrated into:
52
- - Educational platforms with adaptive learning paths
53
- - Automated question bank generators with cognitive level filtering
54
- - Physics tutoring applications with skill-based progression
55
- - Exam preparation software with customized difficulty curves
56
- - Teacher tools for creating balanced assessments
57
 
58
  ### Out-of-Scope Use
59
 
60
- - Generating questions for high-stakes exams without expert validation
61
- - Creating medical or safety-critical content
62
- - Replacing human physics educators entirely
63
- - Generating content outside physics domain
64
- - Using for psychological or cognitive assessment
65
 
66
  ## Bias, Risks, and Limitations
67
 
68
- ### Limitations
69
- - Performance is best on classical physics topics; may struggle with advanced quantum mechanics
70
- - Generated questions should always be reviewed by subject matter experts
71
- - Limited context length (~512 tokens) may affect complex question generation
72
- - Training data primarily from international curriculum standards
73
- - Cognitive skill differentiation may not be perfect for all topics
74
 
75
- ### Risks
76
- - Potential for generating incorrect physics concepts if prompted unusually
77
- - May reflect biases present in the training data
78
- - Should not be used for high-stakes assessment without human oversight
79
- - Cognitive level assignments may not always match intended complexity
80
 
81
  ### Recommendations
82
- Users should:
83
- - Always verify generated questions with physics experts
84
- - Use as a tool to assist educators, not replace them
85
- - Disclose AI-generated content when used in educational materials
86
- - Monitor and review outputs for accuracy and appropriateness
87
- - Validate cognitive skill level assignments for important assessments
88
 
89
  ## How to Get Started with the Model
90
 
91
- ### Basic Usage with Cognitive Skills
92
-
93
- ```python
94
- from transformers import AutoTokenizer, AutoModelForCausalLM
95
- from peft import PeftModel
96
- import torch
97
-
98
- # Load the model
99
- model = AutoModelForCausalLM.from_pretrained(
100
- "microsoft/phi-2",
101
- device_map="auto",
102
- torch_dtype=torch.float16,
103
- trust_remote_code=True
104
- )
105
- model = PeftModel.from_pretrained(model, "your_username/physics-mcq-generator")
106
- tokenizer = AutoTokenizer.from_pretrained("your_username/physics-mcq-generator")
107
- tokenizer.pad_token = tokenizer.eos_token
108
-
109
- def generate_physics_mcq(chapter, topic, difficulty="Medium", cognitive_skill="Application"):
110
- """
111
- Generate a physics MCQ with customizable cognitive skill level
112
-
113
- Cognitive Skill Levels:
114
- - 'Recall': Basic fact recall and definition questions
115
- - 'Application': Applying concepts to solve problems
116
- - 'Analysis': Analyzing situations and relationships
117
- - 'Evaluation': Complex reasoning and critical evaluation
118
- """
119
-
120
- prompt = f"""### Instruction:
121
- Generate a multiple-choice question (MCQ) for a university entrance exam in Physics.
122
-
123
- ### Input:
124
- Subject: Physics | Chapter: {chapter} | Topic: {topic} | Difficulty: {difficulty} | Cognitive_Skill: {cognitive_skill}
125
-
126
- ### Response:
127
- Question:"""
128
-
129
- inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
130
-
131
- with torch.no_grad():
132
- outputs = model.generate(
133
- **inputs,
134
- max_new_tokens=250,
135
- temperature=0.7,
136
- do_sample=True,
137
- pad_token_id=tokenizer.eos_token_id
138
- )
139
-
140
- return tokenizer.decode(outputs[0], skip_special_tokens=True)
141
-
142
- # Examples with different cognitive skills
143
- print("🧠 Recall Question (Basic knowledge):")
144
- mcq = generate_physics_mcq("Mechanics", "Newton's Laws", "Easy", "Recall")
145
- print(mcq)
146
-
147
- print("\n⚡ Application Question (Problem solving):")
148
- mcq = generate_physics_mcq("Electromagnetism", "Ohm's Law", "Medium", "Application")
149
- print(mcq)
150
-
151
- print("\n🔍 Analysis Question (Complex reasoning):")
152
- mcq = generate_physics_mcq("Thermodynamics", "First Law", "Hard", "Analysis")
153
- print(mcq)
154
-
155
- print("\n🎯 Evaluation Question (Critical thinking):")
156
- mcq = generate_physics_mcq("Modern Physics", "Quantum Mechanics", "Hard", "Evaluation")
157
- print(mcq)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
+ - base_model:adapter:microsoft/phi-2
 
 
 
 
 
 
7
  - lora
8
  - transformers
9
  ---
10
 
11
+ # Model Card for Model ID
12
+
13
+ <!-- Provide a quick summary of what the model is/does. -->
14
+
15
 
 
16
 
17
  ## Model Details
18
 
19
  ### Model Description
20
 
21
+ <!-- Provide a longer summary of what this model is. -->
22
+
23
+
24
+
25
+ - **Developed by:** [More Information Needed]
26
+ - **Funded by [optional]:** [More Information Needed]
27
+ - **Shared by [optional]:** [More Information Needed]
28
+ - **Model type:** [More Information Needed]
29
+ - **Language(s) (NLP):** [More Information Needed]
30
+ - **License:** [More Information Needed]
31
+ - **Finetuned from model [optional]:** [More Information Needed]
32
 
33
+ ### Model Sources [optional]
 
 
 
 
34
 
35
+ <!-- Provide the basic links for the model. -->
36
 
37
+ - **Repository:** [More Information Needed]
38
+ - **Paper [optional]:** [More Information Needed]
39
+ - **Demo [optional]:** [More Information Needed]
40
 
41
  ## Uses
42
 
43
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
+
45
  ### Direct Use
46
 
47
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
+
49
+ [More Information Needed]
50
+
51
+ ### Downstream Use [optional]
 
52
 
53
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
54
 
55
+ [More Information Needed]
 
 
 
 
 
56
 
57
  ### Out-of-Scope Use
58
 
59
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
60
+
61
+ [More Information Needed]
 
 
62
 
63
  ## Bias, Risks, and Limitations
64
 
65
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
 
 
 
 
66
 
67
+ [More Information Needed]
 
 
 
 
68
 
69
  ### Recommendations
70
+
71
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
72
+
73
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 
74
 
75
  ## How to Get Started with the Model
76
 
77
+ Use the code below to get started with the model.
78
+
79
+ [More Information Needed]
80
+
81
+ ## Training Details
82
+
83
+ ### Training Data
84
+
85
+ <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
86
+
87
+ [More Information Needed]
88
+
89
+ ### Training Procedure
90
+
91
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
92
+
93
+ #### Preprocessing [optional]
94
+
95
+ [More Information Needed]
96
+
97
+
98
+ #### Training Hyperparameters
99
+
100
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
101
+
102
+ #### Speeds, Sizes, Times [optional]
103
+
104
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
105
+
106
+ [More Information Needed]
107
+
108
+ ## Evaluation
109
+
110
+ <!-- This section describes the evaluation protocols and provides the results. -->
111
+
112
+ ### Testing Data, Factors & Metrics
113
+
114
+ #### Testing Data
115
+
116
+ <!-- This should link to a Dataset Card if possible. -->
117
+
118
+ [More Information Needed]
119
+
120
+ #### Factors
121
+
122
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
123
+
124
+ [More Information Needed]
125
+
126
+ #### Metrics
127
+
128
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
129
+
130
+ [More Information Needed]
131
+
132
+ ### Results
133
+
134
+ [More Information Needed]
135
+
136
+ #### Summary
137
+
138
+
139
+
140
+ ## Model Examination [optional]
141
+
142
+ <!-- Relevant interpretability work for the model goes here -->
143
+
144
+ [More Information Needed]
145
+
146
+ ## Environmental Impact
147
+
148
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
149
+
150
+ Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
151
+
152
+ - **Hardware Type:** [More Information Needed]
153
+ - **Hours used:** [More Information Needed]
154
+ - **Cloud Provider:** [More Information Needed]
155
+ - **Compute Region:** [More Information Needed]
156
+ - **Carbon Emitted:** [More Information Needed]
157
+
158
+ ## Technical Specifications [optional]
159
+
160
+ ### Model Architecture and Objective
161
+
162
+ [More Information Needed]
163
+
164
+ ### Compute Infrastructure
165
+
166
+ [More Information Needed]
167
+
168
+ #### Hardware
169
+
170
+ [More Information Needed]
171
+
172
+ #### Software
173
+
174
+ [More Information Needed]
175
+
176
+ ## Citation [optional]
177
+
178
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
179
+
180
+ **BibTeX:**
181
+
182
+ [More Information Needed]
183
+
184
+ **APA:**
185
+
186
+ [More Information Needed]
187
+
188
+ ## Glossary [optional]
189
+
190
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
191
+
192
+ [More Information Needed]
193
+
194
+ ## More Information [optional]
195
+
196
+ [More Information Needed]
197
+
198
+ ## Model Card Authors [optional]
199
+
200
+ [More Information Needed]
201
+
202
+ ## Model Card Contact
203
+
204
+ [More Information Needed]
205
+ ### Framework versions
206
+
207
+ - PEFT 0.17.1
adapter_config.json CHANGED
@@ -25,9 +25,9 @@
25
  "rank_pattern": {},
26
  "revision": null,
27
  "target_modules": [
28
- "Wqkv",
29
- "fc2",
30
  "fc1",
 
 
31
  "out_proj"
32
  ],
33
  "target_parameters": null,
 
25
  "rank_pattern": {},
26
  "revision": null,
27
  "target_modules": [
 
 
28
  "fc1",
29
+ "fc2",
30
+ "Wqkv",
31
  "out_proj"
32
  ],
33
  "target_parameters": null,
adapter_model.safetensors CHANGED
@@ -1,3 +1,3 @@
1
  version https://git-lfs.github.com/spec/v1
2
- oid sha256:057804f17a89f0abb9dc52b87d2cad20f27a31d9922298987acccacf2735e433
3
  size 104873776
 
1
  version https://git-lfs.github.com/spec/v1
2
+ oid sha256:984d6ff227030d45d5701ef66de50a2d9d60a179b02bff0d89ca7d3bb4f21302
3
  size 104873776