Update README.md
Browse files
README.md
CHANGED
@@ -3,199 +3,87 @@ 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 |
-
###
|
17 |
-
|
18 |
-
<!-- Provide a longer summary of what this model is. -->
|
19 |
-
|
20 |
-
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
21 |
-
|
22 |
-
- **Developed by:** [More Information Needed]
|
23 |
-
- **Funded by [optional]:** [More Information Needed]
|
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 [optional]
|
31 |
-
|
32 |
-
<!-- Provide the basic links for the model. -->
|
33 |
-
|
34 |
-
- **Repository:** [More Information Needed]
|
35 |
-
- **Paper [optional]:** [More Information Needed]
|
36 |
-
- **Demo [optional]:** [More Information Needed]
|
37 |
-
|
38 |
-
## Uses
|
39 |
-
|
40 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
41 |
-
|
42 |
-
### Direct Use
|
43 |
-
|
44 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
45 |
-
|
46 |
-
[More Information Needed]
|
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 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
57 |
-
|
58 |
-
[More Information Needed]
|
59 |
-
|
60 |
-
## Bias, Risks, and Limitations
|
61 |
-
|
62 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
63 |
-
|
64 |
-
[More Information Needed]
|
65 |
-
|
66 |
-
### Recommendations
|
67 |
-
|
68 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
69 |
-
|
70 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
71 |
-
|
72 |
-
## How to Get Started with the Model
|
73 |
-
|
74 |
-
Use the code below to get started with the model.
|
75 |
-
|
76 |
-
[More Information Needed]
|
77 |
-
|
78 |
-
## Training Details
|
79 |
-
|
80 |
-
### Training Data
|
81 |
-
|
82 |
-
<!-- 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. -->
|
83 |
-
|
84 |
-
[More Information Needed]
|
85 |
-
|
86 |
-
### Training Procedure
|
87 |
-
|
88 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
89 |
-
|
90 |
-
#### Preprocessing [optional]
|
91 |
-
|
92 |
-
[More Information Needed]
|
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 |
-
|
146 |
|
147 |
-
|
148 |
|
149 |
-
- **
|
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 |
-
|
156 |
|
157 |
-
|
158 |
|
159 |
-
|
160 |
|
161 |
-
|
|
|
|
|
162 |
|
163 |
-
|
164 |
|
165 |
-
|
166 |
|
167 |
-
|
168 |
|
169 |
-
|
170 |
|
171 |
-
|
|
|
|
|
172 |
|
173 |
-
|
174 |
|
175 |
-
|
176 |
|
177 |
-
|
|
|
|
|
|
|
178 |
|
179 |
-
[
|
180 |
|
181 |
-
|
|
|
|
|
182 |
|
183 |
-
|
|
|
|
|
184 |
|
185 |
-
|
|
|
186 |
|
187 |
-
|
188 |
|
189 |
-
|
190 |
|
191 |
-
##
|
192 |
|
193 |
-
|
194 |
|
195 |
-
##
|
196 |
|
197 |
-
|
|
|
198 |
|
199 |
-
##
|
200 |
|
201 |
-
|
|
|
3 |
tags:
|
4 |
- trl
|
5 |
- grpo
|
6 |
+
license: apache-2.0
|
7 |
+
datasets:
|
8 |
+
- openai/gsm8k
|
9 |
+
language:
|
10 |
+
- en
|
11 |
+
base_model:
|
12 |
+
- google/gemma-3-4b-it
|
13 |
---
|
14 |
+
# Gemma-3-4b Reasoning R1 Model Card
|
15 |
|
16 |
+
Gemma-3-4b Reasoning is a transformer-based language model fine-tuned with GRPO (Group Reward Policy Optimization), leveraging the DeepSeek-R1 methodology. This model card describes the instructed version specifically optimized for reasoning tasks.
|
|
|
|
|
|
|
17 |
|
18 |
+
The entire Gemma-3-4b Reasoning family is available under a permissive Apache 2.0 license. All training scripts and configurations used are publicly accessible.
|
19 |
|
20 |
## Model Details
|
21 |
|
22 |
+
### Description
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
23 |
|
24 |
+
Gemma-3-4b Reasoning is a reasoning-focused fine-tuned model designed to excel in structured, logical problem-solving and mathematical reasoning. The training was performed on the GSM8K dataset using GRPO, enhancing the model's ability to reason step-by-step and provide structured explanations.
|
25 |
|
26 |
+
### Training Dataset
|
27 |
|
28 |
+
- **GSM8K (English)**: Specialized dataset for mathematical and logical reasoning problems.
|
|
|
|
|
|
|
|
|
29 |
|
30 |
+
### Intended Use
|
31 |
|
32 |
+
#### Direct Use
|
33 |
|
34 |
+
The model is specifically designed for structured reasoning tasks, including:
|
35 |
|
36 |
+
- Mathematical and logical reasoning
|
37 |
+
- Multi-step problem solving
|
38 |
+
- Instruction-based reasoning
|
39 |
|
40 |
+
#### Out-of-scope Use
|
41 |
|
42 |
+
This model should not be used for unethical or malicious activities that breach legal and ethical standards.
|
43 |
|
44 |
+
## How to Use
|
45 |
|
46 |
+
The model uses structured XML templates for dialogue and reasoning tasks:
|
47 |
|
48 |
+
```python
|
49 |
+
from transformers import AutoModelForCausalLM, AutoTokenizer
|
50 |
+
import torch
|
51 |
|
52 |
+
model_name = "ericrisco/gemma-3-4b-reasoning"
|
53 |
|
54 |
+
prompt = "A cyclist travels 60 km in 3 hours at a constant speed. If he maintains the same speed, how many kilometers will he travel in 5 hours?"
|
55 |
|
56 |
+
tokenizer = AutoTokenizer.from_pretrained(model_name)
|
57 |
+
model = AutoModelForCausalLM.from_pretrained(
|
58 |
+
model_name, device_map="auto", torch_dtype=torch.bfloat16
|
59 |
+
)
|
60 |
|
61 |
+
messages = [{"role": "user", "content": prompt}]
|
62 |
|
63 |
+
input_text = tokenizer.apply_chat_template(
|
64 |
+
messages, tokenize=False, add_generation_prompt=True
|
65 |
+
)
|
66 |
|
67 |
+
inputs = tokenizer(input_text, return_tensors="pt").to("cuda")
|
68 |
+
outputs = model.generate(**inputs, max_new_tokens=200)
|
69 |
+
response = tokenizer.decode(outputs[0], skip_special_tokens=True)
|
70 |
|
71 |
+
print(response)
|
72 |
+
```
|
73 |
|
74 |
+
# Performance
|
75 |
|
76 |
+
The **Gemma-3-4b Reasoning** model exhibits robust internal **Chain-of-Thought (CoT)** capabilities, consistently demonstrating detailed explanations and structured problem-solving skills across reasoning tasks.
|
77 |
|
78 |
+
## Limitations
|
79 |
|
80 |
+
The model is primarily optimized for **numeric and structured reasoning** and might produce less accurate or unexpected results when applied to unrelated tasks.
|
81 |
|
82 |
+
## Citations
|
83 |
|
84 |
+
- *Gemma Multimodal Reasoning Model* by Google
|
85 |
+
- *GRPO Implementation* by TRL
|
86 |
|
87 |
+
## Author
|
88 |
|
89 |
+
**Eric Risco**
|