Text Generation
Transformers
Safetensors
llama
text-generation-inference
Ashed00 commited on
Commit
d7db17b
·
verified ·
1 Parent(s): 025ad99

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +57 -175
README.md CHANGED
@@ -1,199 +1,81 @@
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
  library_name: transformers
3
+ license: apache-2.0
4
+ datasets:
5
+ - Ashed00/combined_math_problems
6
+ - openai/gsm8k
7
+ - deepmind/aqua_rat
8
+ base_model:
9
+ - HuggingFaceTB/SmolLM2-135M
10
  ---
11
 
12
+ # SmolMath-135M
13
 
14
+ SmolMath is a full finetuned version of SmolLM2-135M parameter, trained to obtain the highest math accuracy, with least drop in other text benchmarks.
15
 
16
+ **Important**: All training codes are present in the (Github)[https://github.com/Ashu-00/SmolMath/]
17
+ **Important**: Please refer to the (Blog)[https://hackmd.io/@ashu-00/SmolMath] for methodology and Training details.
18
 
19
+ ## Usage
20
 
21
+ ```python
22
+ model_path = "Ashed00/SmolMath-135M" # Path where your fine-tuned model is saved
23
+ from transformers import pipeline
24
 
25
+ pipe = pipeline("text-generation", model=model_path)
26
 
27
+ question = "What is 2+2?"
28
 
29
+ prompt = "Question: " + question + "\nAnswer:"
30
 
31
+ output = pipe(
32
+ prompt,
33
+ max_length=100,
34
+ do_sample=False, # disable sampling for greedy decoding
35
+ )[0]["generated_text"]
 
 
36
 
 
37
 
38
+ ```
39
 
40
+ ## Evaluation and Performance
 
 
41
 
42
+ ### Comparision with Base Model
43
+ | **Metrics** | **SmolLM2-135M-8k** | **SmolMath-135M** | **Δ (Change)** |
44
+ |-------------------|---------------------|--------------------|----------------|
45
+ | HellaSwag | 42.1 | 41.15 | −0.95 |
46
+ | PIQA | 68.4 | 63.55 | −4.85 |
47
+ | CommonsenseQA | 33.9 | 33.42 | −0.48 |
48
+ | TriviaQA | 4.1 | 0.0 | −4.10 |
49
+ | Winogrande | 51.3 | 51.78 | +0.48 |
50
+ | OpenBookQA | 34.6 | 30.80 | −3.80 |
51
+ | GSM8K (0-shot)* | 0.0 | 6.9 | +6.90 |
52
 
 
53
 
54
+ *This was evaluated using the lighteval script, which is favoured by the SmolLM2 creators in their evaluation and varies from the SmolMath prompt structure.
55
 
56
+ ### Math Benchmarks
57
+
58
+ | Model | AddSub* (%) | MAWPS** (%) | GSM8K* (%) |
59
+ |----------------------|------------|-----------|-----------|
60
+ | apple/OpenELM-270M-Instruct | 2.14 | 2.83 | 2.05 |
61
+ | HuggingFaceTB/SmolLM2-135M-Instruct | 1.52 |4.04 | 0.45 |
62
+ | SmolMath-no GRPO (ours) | 9.64 | 7.47 | 6.22 |
63
+ | SmolMath (ours) | **12.05** | **8.31** | **7.51** |
64
 
65
+ *Evaluated only on the test set, not included in the training
66
+ **Evaluated on complete dataset, not included in the training
67
 
68
+ ## Citation
69
 
70
+ Incase you want to use this model in your work, you can site us.
71
 
72
+ ```
73
+ @misc{SmolMath,
74
+ title = {Building SmolMath: A Math Reasoning SLM Under 150M Parameters},
75
+ url = {https://hackmd.io/@ashu-00/SmolMath},
76
+ author = {ashu-00},
77
+ month = {July},
78
+ year = {2025}
79
+ }
80
 
81
+ ```