ujjwal52 commited on
Commit
a70725a
·
verified ·
1 Parent(s): 108650b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +88 -165
README.md CHANGED
@@ -1,199 +1,122 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
 
76
  ## Training Details
77
 
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
 
161
- [More Information Needed]
 
 
 
162
 
163
- #### Hardware
 
164
 
165
- [More Information Needed]
166
 
167
- #### Software
168
 
169
- [More Information Needed]
 
 
170
 
171
- ## Citation [optional]
 
172
 
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
174
 
175
- **BibTeX:**
 
 
 
 
 
 
 
176
 
177
- [More Information Needed]
 
 
178
 
179
- **APA:**
 
 
180
 
181
- [More Information Needed]
 
 
182
 
183
- ## Glossary [optional]
 
 
 
 
 
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
 
187
- [More Information Needed]
 
 
 
188
 
189
- ## More Information [optional]
190
 
191
- [More Information Needed]
192
 
193
- ## Model Card Authors [optional]
194
 
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
 
 
 
 
 
 
 
198
 
199
- [More Information Needed]
 
 
 
 
 
 
 
 
1
  ---
2
+ pretty_name: Qwen2-complex-UK
3
+ base_model: Qwen/Qwen2-Math-1.5B
4
+ tags:
5
+ - text-generation
6
+ - qlora
7
+ - maths
8
+ - finetuned
9
+ - collab
10
+ widget:
11
+ - text: "If $f(x) = \frac{3x-2}{x-2}$, what is the value of $f(-2) +f(-1)+f(0)$? Express your answer as a common fraction."
12
+ example_title: Math Problem Solving
13
+ license: mit
14
+ datasets:
15
+ - ujjwal52/Maths-medium-7k-COT-Uk
16
  ---
17
 
18
+ # Model Card: Qwen2-complex-UK
19
 
20
+ ## Model Description
21
 
22
+ **Qwen2-complex-UK** is a fine-tuned large language model specialized in solving complex mathematical problems, particularly those involving symbolic manipulation, function evaluation, and algebraic expressions. It is built upon the powerful **Qwen2-Math-1.5B** base model by Qwen, further enhancing its capabilities for precise and step-by-step mathematical reasoning.
23
 
24
+ This model was fine-tuned using the **ujjwal52/Maths-medium-7k-COT-Uk** dataset, which provides a rich collection of mathematical problems with Chain-of-Thought (COT) explanations. This allows the model to not only provide correct answers but also to articulate the reasoning process, making it highly suitable for educational applications, research, and any task requiring interpretable mathematical solutions.
25
 
26
+ ## Why Choose This Model?
27
 
28
+ **1. Enhanced Mathematical Reasoning:** While the base Qwen2-Math-1.5B is already proficient, this fine-tuned version excels in handling more complex and nuanced mathematical queries. The specific dataset used focuses on medium-difficulty problems, ensuring robust performance across a range of mathematical challenges.
29
 
30
+ **2. Chain-of-Thought (COT) Capabilities:** Thanks to the training dataset, Qwen2-complex-UK can generate detailed, logical steps to arrive at a solution. This is invaluable for users who need to understand *how* an answer was derived, not just *what* the answer is.
31
 
32
+ **3. Efficiency with QLoRA:** Fine-tuned using QLoRA with 4-bit quantization, this model achieves impressive performance while maintaining a relatively small footprint, making it accessible for deployment in environments with limited resources.
33
 
34
+ **4. Versatile Applications:** Ideal for automated math problem solvers, intelligent tutoring systems, content generation for math education, and assisting researchers with complex calculations.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
  ## Training Details
37
 
38
+ ### Base Model
39
+ * **Qwen/Qwen2-Math-1.5B**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
40
 
41
+ ### Fine-tuning Method
42
+ * **QLoRA (Quantized LoRA):** Efficient fine-tuning technique that reduces memory usage during training.
43
+
44
+ * **4-bit Quantization:** Model weights loaded in 4-bit NormalFloat (NF4) precision for memory efficiency.
45
 
46
+ ### Dataset
47
+ * **ujjwal52/Maths-medium-7k-COT-Uk:** A specialized dataset containing 7,000 medium-difficulty mathematical problems with detailed Chain-of-Thought (COT) explanations
48
 
49
+ ## How to Use
50
 
51
+ This model can be easily loaded and used for text generation tasks, particularly for mathematical problem-solving. Here's how you can use it with the `transformers` library:
52
 
53
+ ```python
54
+ import torch
55
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
56
 
57
+ # Define the model ID on Hugging Face
58
+ model_id = "ujjwal52/Qwen2-complex-UK"
59
 
60
+ # Load tokenizer
61
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
62
 
63
+ # Load model (make sure to specify the correct dtype and device_map for your setup)
64
+ # If you saved it with 4-bit, you might need BitsAndBytesConfig for inference if not merged fully
65
+ # For the merged model, float16 is usually appropriate.
66
+ model = AutoModelForCausalLM.from_pretrained(
67
+ model_id,
68
+ torch_dtype=torch.float16, # Use the dtype the merged model was saved in
69
+ device_map="auto", # Automatically maps model to available devices (e.g., GPU)
70
+ )
71
 
72
+ # Create a text generation pipeline
73
+ prompt = "If $f(x) = \frac{3x-2}{x-2}$, what is the value of $f(-2) +f(-1)+f(0)$? Express your answer as a common fraction.,ans carefully"
74
+ pipe = pipeline(task="text-generation", model=model, tokenizer=tokenizer, max_length=3500)
75
 
76
+ # Format the prompt according to the Llama 2 chat template (or Qwen2's equivalent)
77
+ # The fine-tuning typically uses a specific template, here we assume a chat-like structure.
78
+ chat_template_prompt = f"<s>[INST] {prompt} [/INST]"
79
 
80
+ # Generate text
81
+ result = pipe(chat_template_prompt)
82
+ print(result[0]['generated_text'])
83
 
84
+ # Another example:
85
+ prompt_2 = "Solve the equation: $2x + 5 = 11$. Explain your steps."
86
+ chat_template_prompt_2 = f"<s>[INST] {prompt_2} [/INST]"
87
+ result_2 = pipe(chat_template_prompt_2)
88
+ print(result_2[0]['generated_text'])
89
+ ```
90
 
91
+ ## Limitations and Biases
92
 
93
+ * **Mathematical Domain:** While strong in algebra and function evaluation, the model's performance might vary in other highly specialized mathematical fields (e.g., advanced topology, quantum mechanics) not extensively covered in its training data.
94
+ * **Problem Complexity:** The model was fine-tuned on medium-difficulty problems. Very simple or extremely complex, open-ended mathematical research questions might still pose a challenge.
95
+ * **Hallucination:** Like all large language models, it can sometimes generate plausible-sounding but incorrect information. Always verify critical mathematical results.
96
+ * **Language Bias:** The dataset (`ujjwal52/Maths-medium-7k-COT-Uk`) influences the model's style and terminology. Be aware of potential biases in how problems are framed or solved.
97
 
98
+ ## License
99
 
100
+ This model is based on Qwen2-Math-1.5B, which is typically under a specific license (e.g., Apache 2.0 or similar permissive license). Please refer to the [Qwen2-Math-1.5B model page](https://huggingface.co/Qwen/Qwen2-Math-1.5B) for its exact licensing terms. The fine-tuned weights inherit the base model's license.
101
 
102
+ ## Citation
103
 
104
+ If you use this model in your research or application, please consider citing the original Qwen2 work and the dataset used for fine-tuning:
105
 
106
+ ```bibtex
107
+ @misc{qwen2,
108
+ title={Qwen2: A New Series of Large Language Models},
109
+ author={The Qwen Team},
110
+ year={2024},
111
+ publisher={Hugging Face},
112
+ url={https://huggingface.co/Qwen/Qwen2-Math-1.5B}
113
+ }
114
 
115
+ @misc{maths_medium_7k_cot_uk,
116
+ title={Maths-medium-7k-COT-Uk Dataset},
117
+ author={ujjwal52},
118
+ year={2024},
119
+ publisher={Hugging Face},
120
+ url={https://huggingface.co/datasets/ujjwal52/Maths-medium-7k-COT-Uk}
121
+ }
122
+ ```