ubermenchh commited on
Commit
18da4ef
·
verified ·
1 Parent(s): 8fedb1b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +117 -195
README.md CHANGED
@@ -1,202 +1,124 @@
1
  ---
2
- library_name: transformers
3
  tags:
 
 
4
  - unsloth
 
5
  - trl
6
  - grpo
 
 
 
 
 
7
  ---
8
 
9
- # Model Card for Model ID
10
-
11
- <!-- Provide a quick summary of what the model is/does. -->
12
-
13
-
14
-
15
- ## Model Details
16
-
17
- ### Model Description
18
-
19
- <!-- Provide a longer summary of what this model is. -->
20
-
21
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
22
-
23
- - **Developed by:** [More Information Needed]
24
- - **Funded by [optional]:** [More Information Needed]
25
- - **Shared by [optional]:** [More Information Needed]
26
- - **Model type:** [More Information Needed]
27
- - **Language(s) (NLP):** [More Information Needed]
28
- - **License:** [More Information Needed]
29
- - **Finetuned from model [optional]:** [More Information Needed]
30
-
31
- ### Model Sources [optional]
32
-
33
- <!-- Provide the basic links for the model. -->
34
-
35
- - **Repository:** [More Information Needed]
36
- - **Paper [optional]:** [More Information Needed]
37
- - **Demo [optional]:** [More Information Needed]
38
-
39
- ## Uses
40
-
41
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
42
-
43
- ### Direct Use
44
-
45
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
46
-
47
- [More Information Needed]
48
-
49
- ### Downstream Use [optional]
50
-
51
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
52
-
53
- [More Information Needed]
54
-
55
- ### Out-of-Scope Use
56
-
57
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
58
-
59
- [More Information Needed]
60
-
61
- ## Bias, Risks, and Limitations
62
-
63
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
-
65
- [More Information Needed]
66
-
67
- ### Recommendations
68
-
69
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
-
71
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
72
-
73
- ## How to Get Started with the Model
74
-
75
- Use the code below to get started with the model.
76
-
77
- [More Information Needed]
78
-
79
- ## Training Details
80
-
81
- ### Training Data
82
-
83
- <!-- 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. -->
84
-
85
- [More Information Needed]
86
-
87
- ### Training Procedure
88
-
89
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
90
-
91
- #### Preprocessing [optional]
92
-
93
- [More Information Needed]
94
-
95
-
96
- #### Training Hyperparameters
97
-
98
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
99
-
100
- #### Speeds, Sizes, Times [optional]
101
-
102
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
103
-
104
- [More Information Needed]
105
-
106
- ## Evaluation
107
-
108
- <!-- This section describes the evaluation protocols and provides the results. -->
109
-
110
- ### Testing Data, Factors & Metrics
111
-
112
- #### Testing Data
113
-
114
- <!-- This should link to a Dataset Card if possible. -->
115
-
116
- [More Information Needed]
117
-
118
- #### Factors
119
-
120
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
121
-
122
- [More Information Needed]
123
-
124
- #### Metrics
125
-
126
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
127
-
128
- [More Information Needed]
129
-
130
- ### Results
131
-
132
- [More Information Needed]
133
-
134
- #### Summary
135
-
136
-
137
-
138
- ## Model Examination [optional]
139
-
140
- <!-- Relevant interpretability work for the model goes here -->
141
-
142
- [More Information Needed]
143
-
144
- ## Environmental Impact
145
-
146
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
147
-
148
- 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).
149
-
150
- - **Hardware Type:** [More Information Needed]
151
- - **Hours used:** [More Information Needed]
152
- - **Cloud Provider:** [More Information Needed]
153
- - **Compute Region:** [More Information Needed]
154
- - **Carbon Emitted:** [More Information Needed]
155
-
156
- ## Technical Specifications [optional]
157
-
158
- ### Model Architecture and Objective
159
-
160
- [More Information Needed]
161
-
162
- ### Compute Infrastructure
163
-
164
- [More Information Needed]
165
-
166
- #### Hardware
167
-
168
- [More Information Needed]
169
-
170
- #### Software
171
-
172
- [More Information Needed]
173
-
174
- ## Citation [optional]
175
-
176
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
177
-
178
- **BibTeX:**
179
-
180
- [More Information Needed]
181
-
182
- **APA:**
183
-
184
- [More Information Needed]
185
-
186
- ## Glossary [optional]
187
-
188
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
189
-
190
- [More Information Needed]
191
-
192
- ## More Information [optional]
193
-
194
- [More Information Needed]
195
-
196
- ## Model Card Authors [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Contact
201
-
202
- [More Information Needed]
 
1
  ---
2
+ base_model: unsloth/qwen2.5-3b-instruct-unsloth-bnb-4bit
3
  tags:
4
+ - text-generation-inference
5
+ - transformers
6
  - unsloth
7
+ - qwen2
8
  - trl
9
  - grpo
10
+ license: apache-2.0
11
+ language:
12
+ - en
13
+ datasets:
14
+ - open-r1/OpenR1-Math-220k
15
  ---
16
 
17
+ This is my experiment with training a reasoning model using TRL's GRPO and Unsloth API.
18
+
19
+ # Inference:
20
+ ## Using Unsloth API (For Faster Inference):
21
+ ```
22
+ import torch
23
+ from unsloth import FastLanguageModel
24
+ from transformers import TextStreamer
25
+
26
+ model, tokenizer = FastLanguageModel.from_pretrained(
27
+ model_name = "ubermenchh/Qwen2.5-3B-open-r1-math",
28
+ max_seq_length = 1024,
29
+ dtype = torch.bfloat16,
30
+ load_in_4bit = True,
31
+ )
32
+ FastLanguageModel.for_inference(model)
33
+
34
+ SYSTEM_PROMPT = """
35
+ Respond in the following format:
36
+ <think>
37
+ ...
38
+ </think>
39
+ <answer>
40
+ ...
41
+ </answer>
42
+ """
43
+
44
+ test_question = """
45
+ Let $z \in \mathbf{C}$, satisfying the condition $a z^{n}+b \mathrm{i} z^{n-1}+b \mathrm{i} z-a=0, a, b \in \mathbf{R}, m \in$ $\mathbf{N}$, find $|z|$.
46
+ """
47
+
48
+ messages = [
49
+ {"role": "system", "content": SYSTEM_PROMPT},
50
+ {"role": "user", "content": test_question},
51
+ ]
52
+ input_ids = tokenizer.apply_chat_template(
53
+ messages,
54
+ add_generation_prompt = True,
55
+ return_tensors = "pt",
56
+ ).to("cuda")
57
+
58
+ text_streamer = TextStreamer(tokenizer, skip_prompt = True)
59
+ _ = model.generate(input_ids, streamer = text_streamer, max_new_tokens = 2048, pad_token_id = tokenizer.eos_token_id)
60
+ ```
61
+ ## Using Transformers API:
62
+ ```
63
+ from transformers import AutoModelForCausalLM, AutoTokenizer
64
+ import torch
65
+
66
+ model = AutoModelForCausalLM.from_pretrained(
67
+ "ubermenchh/Qwen2.5-3B-open-r1-math",
68
+ torch_dtype=torch.bfloat16,
69
+ device_map="auto",
70
+ trust_remote_code=True
71
+ )
72
+ tokenizer = AutoTokenizer.from_pretrained(
73
+ "ubermenchh/Qwen2.5-3B-open-r1-math",
74
+ trust_remote_code=True
75
+ )
76
+
77
+ SYSTEM_PROMPT = """
78
+ Respond in the following format:
79
+ <think>
80
+ ...
81
+ </think>
82
+ <answer>
83
+ ...
84
+ </answer>
85
+ """
86
+
87
+ problem = "Let $z \in \mathbf{C}$, satisfying the condition $a z^{n}+b \mathrm{i} z^{n-1}+b \mathrm{i} z-a=0, a, b \in \mathbf{R}, m \in$ $\mathbf{N}$, find $|z|$."
88
+ prompt = [
89
+ {"role": "system", "content": SYSTEM_PROMPT},
90
+ {"role": "user", "content": problem}
91
+ ]
92
+
93
+ input_text = tokenizer.apply_chat_template(prompt, tokenize=False, add_generation_prompt=True)
94
+ inputs = tokenizer(input_text, return_tensors="pt").to(model.device)
95
+
96
+ outputs = model.generate(
97
+ **inputs,
98
+ max_new_tokens=3000,
99
+ temperature=1.3,
100
+ num_return_sequences=1,
101
+ pad_token_id=tokenizer.pad_token_id,
102
+ eos_token_id=tokenizer.eos_token_id
103
+ )
104
+
105
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
106
+
107
+ print("Question:\n", problem)
108
+ print("\n\nResponse:\n", response)
109
+ ```
110
+
111
+ ## References:
112
+ - [https://github.com/HarleyCoops/smolThinker-.5B](https://github.com/HarleyCoops/smolThinker-.5B)
113
+ - [https://gist.github.com/willccbb/4676755236bb08cab5f4e54a0475d6fb](https://gist.github.com/willccbb/4676755236bb08cab5f4e54a0475d6fb)
114
+ - [https://github.com/huggingface/open-r1](https://github.com/huggingface/open-r1)
115
+
116
+ # Uploaded model
117
+
118
+ - **Developed by:** ubermenchh
119
+ - **License:** apache-2.0
120
+ - **Finetuned from model :** unsloth/qwen2.5-3b-instruct-unsloth-bnb-4bit
121
+
122
+ This qwen2 model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
123
+
124
+ [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)