Update README.md
Browse files
README.md
CHANGED
@@ -1,201 +1,82 @@
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
tags:
|
4 |
-
- trl
|
5 |
-
- grpo
|
|
|
|
|
6 |
---
|
7 |
|
8 |
-
#
|
9 |
-
|
10 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
11 |
-
|
12 |
|
|
|
13 |
|
14 |
## Model Details
|
15 |
|
16 |
### Model Description
|
17 |
|
18 |
-
|
19 |
-
|
20 |
-
|
|
|
|
|
|
|
21 |
|
22 |
-
- **Developed by:** [
|
23 |
-
- **
|
24 |
-
- **Shared by [optional]:** [More Information Needed]
|
25 |
-
- **Model type:** [More Information Needed]
|
26 |
-
- **Language(s) (NLP):** [More Information Needed]
|
27 |
-
- **License:** [More Information Needed]
|
28 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
29 |
|
30 |
-
### Model Sources
|
31 |
|
32 |
-
|
33 |
-
|
34 |
-
- **
|
35 |
-
- **Paper [optional]:** [More Information Needed]
|
36 |
-
- **Demo [optional]:** [More Information Needed]
|
37 |
|
38 |
## Uses
|
39 |
|
40 |
-
|
41 |
-
|
42 |
-
### Direct Use
|
43 |
|
44 |
-
|
45 |
-
|
46 |
-
|
47 |
-
|
48 |
-
### Downstream Use [optional]
|
49 |
-
|
50 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
51 |
-
|
52 |
-
[More Information Needed]
|
53 |
|
54 |
### Out-of-Scope Use
|
55 |
|
56 |
-
|
57 |
-
|
58 |
-
|
59 |
|
60 |
## Bias, Risks, and Limitations
|
61 |
|
62 |
-
|
63 |
-
|
64 |
-
|
|
|
65 |
|
66 |
### Recommendations
|
67 |
|
68 |
-
|
69 |
-
|
70 |
-
|
|
|
71 |
|
72 |
## How to Get Started with the Model
|
73 |
|
74 |
-
|
75 |
-
|
76 |
-
|
77 |
-
|
78 |
-
|
79 |
-
|
80 |
-
|
81 |
-
|
82 |
-
|
83 |
-
|
84 |
-
|
85 |
-
|
86 |
-
|
87 |
-
|
88 |
-
|
89 |
-
|
90 |
-
|
91 |
-
|
92 |
-
[
|
93 |
-
|
94 |
-
|
95 |
-
#### Training Hyperparameters
|
96 |
-
|
97 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
98 |
-
|
99 |
-
#### Speeds, Sizes, Times [optional]
|
100 |
-
|
101 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
102 |
-
|
103 |
-
[More Information Needed]
|
104 |
-
|
105 |
-
## Evaluation
|
106 |
-
|
107 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
108 |
-
|
109 |
-
### Testing Data, Factors & Metrics
|
110 |
-
|
111 |
-
#### Testing Data
|
112 |
-
|
113 |
-
<!-- This should link to a Dataset Card if possible. -->
|
114 |
-
|
115 |
-
[More Information Needed]
|
116 |
-
|
117 |
-
#### Factors
|
118 |
-
|
119 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
120 |
-
|
121 |
-
[More Information Needed]
|
122 |
-
|
123 |
-
#### Metrics
|
124 |
-
|
125 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
126 |
-
|
127 |
-
[More Information Needed]
|
128 |
-
|
129 |
-
### Results
|
130 |
-
|
131 |
-
[More Information Needed]
|
132 |
-
|
133 |
-
#### Summary
|
134 |
-
|
135 |
-
|
136 |
-
|
137 |
-
## Model Examination [optional]
|
138 |
-
|
139 |
-
<!-- Relevant interpretability work for the model goes here -->
|
140 |
-
|
141 |
-
[More Information Needed]
|
142 |
-
|
143 |
-
## Environmental Impact
|
144 |
-
|
145 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
146 |
-
|
147 |
-
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).
|
148 |
-
|
149 |
-
- **Hardware Type:** [More Information Needed]
|
150 |
-
- **Hours used:** [More Information Needed]
|
151 |
-
- **Cloud Provider:** [More Information Needed]
|
152 |
-
- **Compute Region:** [More Information Needed]
|
153 |
-
- **Carbon Emitted:** [More Information Needed]
|
154 |
-
|
155 |
-
## Technical Specifications [optional]
|
156 |
-
|
157 |
-
### Model Architecture and Objective
|
158 |
-
|
159 |
-
[More Information Needed]
|
160 |
-
|
161 |
-
### Compute Infrastructure
|
162 |
-
|
163 |
-
[More Information Needed]
|
164 |
-
|
165 |
-
#### Hardware
|
166 |
-
|
167 |
-
[More Information Needed]
|
168 |
-
|
169 |
-
#### Software
|
170 |
-
|
171 |
-
[More Information Needed]
|
172 |
-
|
173 |
-
## Citation [optional]
|
174 |
-
|
175 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
176 |
-
|
177 |
-
**BibTeX:**
|
178 |
-
|
179 |
-
[More Information Needed]
|
180 |
-
|
181 |
-
**APA:**
|
182 |
-
|
183 |
-
[More Information Needed]
|
184 |
-
|
185 |
-
## Glossary [optional]
|
186 |
-
|
187 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
188 |
-
|
189 |
-
[More Information Needed]
|
190 |
-
|
191 |
-
## More Information [optional]
|
192 |
-
|
193 |
-
[More Information Needed]
|
194 |
-
|
195 |
-
## Model Card Authors [optional]
|
196 |
-
|
197 |
-
[More Information Needed]
|
198 |
-
|
199 |
-
## Model Card Contact
|
200 |
-
|
201 |
-
[More Information Needed]
|
|
|
1 |
---
|
2 |
library_name: transformers
|
3 |
tags:
|
4 |
+
- trl
|
5 |
+
- grpo
|
6 |
+
- qwen
|
7 |
+
- gsm8k
|
8 |
---
|
9 |
|
10 |
+
# Qwen-0.5B-GRPO: A Fine-Tuned Math Reasoner
|
|
|
|
|
|
|
11 |
|
12 |
+
This model is a fine-tuned version of the Qwen 0.5B model (based on [Qwen/Qwen2.5-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct)) using GRPO (Generative Reward Policy Optimization). It has been trained on the GSM8K math dataset to improve its ability to generate step-by-step reasoning for math problems, following a structured output format with explicit `<reasoning>` and `<answer>` sections.
|
13 |
|
14 |
## Model Details
|
15 |
|
16 |
### Model Description
|
17 |
|
18 |
+
Qwen-0.5B-GRPO is designed to serve as a lightweight math reasoning assistant. By fine-tuning with reinforcement learning using GRPO, the model learns to produce responses that include both intermediate reasoning and final answers. Key adaptations include:
|
19 |
+
- **Base Model:** Qwen/Qwen2.5-0.5B-Instruct
|
20 |
+
- **Fine-Tuning Method:** GRPO (reinforcement learning with custom reward functions)
|
21 |
+
- **Dataset:** GSM8K – a collection of challenging grade-school math problems
|
22 |
+
- **Generation Engine:** Utilizes vLLM for faster inference on a single GPU setup
|
23 |
+
- **Precision:** BF16 training for efficiency on Colab GPUs
|
24 |
|
25 |
+
- **Developed by:** [Your Name or Organization]
|
26 |
+
- **License:** Please refer to the license of the base model on its Hugging Face Hub page
|
|
|
|
|
|
|
|
|
|
|
27 |
|
28 |
+
### Model Sources
|
29 |
|
30 |
+
- **Repository (this model):** [https://huggingface.co/emre/Qwen-0.5B-GRPO](https://huggingface.co/emre/Qwen-0.5B-GRPO)
|
31 |
+
- **Base Model Repository:** [https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct)
|
32 |
+
- **Dataset:** [https://huggingface.co/datasets/openai/gsm8k](https://huggingface.co/datasets/openai/gsm8k)
|
|
|
|
|
33 |
|
34 |
## Uses
|
35 |
|
36 |
+
### Intended Use
|
|
|
|
|
37 |
|
38 |
+
This model is intended for educational and research purposes, particularly to demonstrate and support math problem solving with clear, step-by-step reasoning. It is well-suited for:
|
39 |
+
- Generating structured explanations for math problems.
|
40 |
+
- Serving as a lightweight assistant in educational applications focused on math reasoning.
|
|
|
|
|
|
|
|
|
|
|
|
|
41 |
|
42 |
### Out-of-Scope Use
|
43 |
|
44 |
+
- **High-Stakes Decision Making:** This model is not designed for critical decision making.
|
45 |
+
- **Non-Math Domains:** Its performance is tailored to math problems; performance on other domains may be limited.
|
46 |
+
- **Over-Reliance on Automated Reasoning:** The reward functions used during fine-tuning (e.g., exact string matching) may not capture all nuances, so human oversight is recommended.
|
47 |
|
48 |
## Bias, Risks, and Limitations
|
49 |
|
50 |
+
- **Model Size:** With only 0.5B parameters, it may not perform as robustly as larger models.
|
51 |
+
- **Training Duration:** Fine-tuning was performed for a single epoch; further training might be needed for more challenging tasks.
|
52 |
+
- **Reward Function Limitations:** The custom reward functions (checking for correct formatting and numerical correctness) are heuristic and may occasionally miss subtleties in reasoning.
|
53 |
+
- **Generalization:** The structured format (with `<reasoning>` and `<answer>` tags) is enforced during training and may require adaptation for other use cases.
|
54 |
|
55 |
### Recommendations
|
56 |
|
57 |
+
Users should:
|
58 |
+
- Validate model outputs on a case-by-case basis.
|
59 |
+
- Consider further fine-tuning for domain-specific applications.
|
60 |
+
- Use the model as a supplementary tool rather than the sole resource for critical math reasoning tasks.
|
61 |
|
62 |
## How to Get Started with the Model
|
63 |
|
64 |
+
Below is an example code snippet to load and use the model:
|
65 |
+
|
66 |
+
```python
|
67 |
+
from transformers import AutoTokenizer, AutoModelForCausalLM
|
68 |
+
import torch
|
69 |
+
|
70 |
+
model_name = "emre/Qwen-0.5B-GRPO"
|
71 |
+
tokenizer = AutoTokenizer.from_pretrained(model_name)
|
72 |
+
model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=torch.bfloat16).to("cuda")
|
73 |
+
|
74 |
+
# Example prompt: structured with <reasoning> and <answer> tags.
|
75 |
+
prompt = """<reasoning>
|
76 |
+
Step-by-step reasoning:
|
77 |
+
</reasoning>
|
78 |
+
<answer>
|
79 |
+
"""
|
80 |
+
inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
|
81 |
+
outputs = model.generate(**inputs, max_length=300)
|
82 |
+
print(tokenizer.decode(outputs[0], skip_special_tokens=True))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|