danxh commited on
Commit
1b99e87
·
verified ·
1 Parent(s): f537151

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +70 -181
README.md CHANGED
@@ -1,207 +1,96 @@
1
  ---
2
- base_model: deepseek-ai/deepseek-math-7b-instruct
3
- library_name: peft
4
- pipeline_tag: text-generation
 
 
 
 
 
 
5
  tags:
6
- - base_model:adapter:deepseek-ai/deepseek-math-7b-instruct
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
 
1
  ---
2
+ title: Math-MCQ-Generator-v1
3
+ emoji: 🧮
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: gradio
7
+ sdk_version: 4.0.0
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
  tags:
12
+ - text-generation
13
+ - mathematics
14
+ - mcq-generation
15
+ - education
16
+ - fine-tuned
17
+ - deepseek-math
18
  ---
19
 
20
+ # Math-MCQ-Generator-v1
21
 
22
+ ## 📋 Model Description
23
 
24
+ This is a fine-tuned version of `deepseek-ai/deepseek-math-7b-instruct` specialized for generating high-quality mathematics multiple choice questions (MCQs). The model has been trained using QLoRA (Quantized Low-Rank Adaptation) to efficiently adapt the base model for educational content generation.
25
 
26
+ ## 🎯 Capabilities
27
 
28
+ - **Subject**: Mathematics
29
+ - **Question Types**: Multiple Choice Questions (MCQs)
30
+ - **Topics**: Applications of Trigonometry, Conic Sections, and more
31
+ - **Difficulty Levels**: Easy, Medium, Hard
32
+ - **Cognitive Skills**: Recall, Direct Application, Pattern Recognition, Strategic Reasoning, Trap Aware
33
 
34
+ ## 📊 Training Information
35
 
36
+ - **Base Model**: `deepseek-ai/deepseek-math-7b-instruct`
37
+ - **Training Method**: QLoRA (4-bit quantization)
38
+ - **Dataset Size**: 1519 examples
39
+ - **Training Epochs**: 5
40
+ - **Final Loss**: ~0.20
41
+ - **Training Date**: 2025-09-03
42
 
43
+ ## 🚀 Usage
44
 
45
+ ### Via Gradio Interface (Recommended)
46
+ Visit the Spaces page to interact with the model through a user-friendly interface.
47
 
48
+ ### Via Python API
49
+ ```python
50
+ from transformers import AutoTokenizer, AutoModelForCausalLM
51
+ from peft import PeftModel
 
 
 
52
 
53
+ # Load model
54
+ base_model = AutoModelForCausalLM.from_pretrained("deepseek-ai/deepseek-math-7b-instruct")
55
+ model = PeftModel.from_pretrained(base_model, "your-username/math-mcq-generator-v1")
56
+ tokenizer = AutoTokenizer.from_pretrained("your-username/math-mcq-generator-v1")
57
 
58
+ # Generate MCQ
59
+ prompt = '''### Instruction:
60
+ Generate a math MCQ similar in style to the provided examples.
61
 
62
+ ### Input:
63
+ chapter: Applications of Trigonometry
64
+ topics: ['Heights and Distances']
65
+ Difficulty: medium
66
+ Cognitive Skill: direct_application
67
 
68
+ ### Response:
69
+ '''
70
 
71
+ inputs = tokenizer(prompt, return_tensors="pt")
72
+ outputs = model.generate(**inputs, max_new_tokens=300, temperature=0.7)
73
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
74
+ ```
75
 
76
+ ## 📈 Performance
77
 
78
+ The model demonstrates strong performance in generating contextually appropriate mathematics MCQs with:
79
+ - Proper question formatting
80
+ - Relevant multiple choice options
81
+ - Appropriate difficulty scaling
82
+ - Subject-matter accuracy
83
 
84
+ ## 🤝 Collaboration
85
 
86
+ This model is part of a collaborative effort to create specialized educational AI tools. A companion Physics MCQ generator is also available.
87
 
88
+ ## 📄 License
89
 
90
+ MIT License - Feel free to use, modify, and distribute.
91
 
92
+ ## 🙏 Acknowledgments
93
 
94
+ - Base model by DeepSeek AI
95
+ - Training infrastructure supported by Hugging Face
96
+ - Educational content expertise from domain specialists