suayptalha commited on
Commit
b54e382
·
verified ·
1 Parent(s): 4b84445

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +64 -177
README.md CHANGED
@@ -1,200 +1,87 @@
1
  ---
2
  library_name: transformers
3
  tags:
 
 
 
 
 
 
 
4
  - unsloth
 
 
 
 
 
 
 
5
  ---
6
 
7
- # Model Card for Model ID
8
 
9
- <!-- Provide a quick summary of what the model is/does. -->
 
10
 
 
11
 
 
12
 
13
- ## Model Details
14
 
15
- ### Model Description
 
 
 
16
 
17
- <!-- Provide a longer summary of what this model is. -->
18
 
19
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
 
20
 
21
- - **Developed by:** [More Information Needed]
22
- - **Funded by [optional]:** [More Information Needed]
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Model type:** [More Information Needed]
25
- - **Language(s) (NLP):** [More Information Needed]
26
- - **License:** [More Information Needed]
27
- - **Finetuned from model [optional]:** [More Information Needed]
28
 
29
- ### Model Sources [optional]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
 
31
- <!-- Provide the basic links for the model. -->
32
 
33
- - **Repository:** [More Information Needed]
34
- - **Paper [optional]:** [More Information Needed]
35
- - **Demo [optional]:** [More Information Needed]
36
 
37
- ## Uses
 
 
 
38
 
39
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
40
 
41
- ### Direct Use
42
 
43
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 
 
44
 
45
- [More Information Needed]
46
 
47
- ### Downstream Use [optional]
48
-
49
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
50
-
51
- [More Information Needed]
52
-
53
- ### Out-of-Scope Use
54
-
55
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
56
-
57
- [More Information Needed]
58
-
59
- ## Bias, Risks, and Limitations
60
-
61
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
-
63
- [More Information Needed]
64
-
65
- ### Recommendations
66
-
67
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
-
69
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
-
71
- ## How to Get Started with the Model
72
-
73
- Use the code below to get started with the model.
74
-
75
- [More Information Needed]
76
-
77
- ## Training Details
78
-
79
- ### Training Data
80
-
81
- <!-- 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. -->
82
-
83
- [More Information Needed]
84
-
85
- ### Training Procedure
86
-
87
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
88
-
89
- #### Preprocessing [optional]
90
-
91
- [More Information Needed]
92
-
93
-
94
- #### Training Hyperparameters
95
-
96
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
97
-
98
- #### Speeds, Sizes, Times [optional]
99
-
100
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
101
-
102
- [More Information Needed]
103
-
104
- ## Evaluation
105
-
106
- <!-- This section describes the evaluation protocols and provides the results. -->
107
-
108
- ### Testing Data, Factors & Metrics
109
-
110
- #### Testing Data
111
-
112
- <!-- This should link to a Dataset Card if possible. -->
113
-
114
- [More Information Needed]
115
-
116
- #### Factors
117
-
118
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Metrics
123
-
124
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
125
-
126
- [More Information Needed]
127
-
128
- ### Results
129
-
130
- [More Information Needed]
131
-
132
- #### Summary
133
-
134
-
135
-
136
- ## Model Examination [optional]
137
-
138
- <!-- Relevant interpretability work for the model goes here -->
139
-
140
- [More Information Needed]
141
-
142
- ## Environmental Impact
143
-
144
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
145
-
146
- 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).
147
-
148
- - **Hardware Type:** [More Information Needed]
149
- - **Hours used:** [More Information Needed]
150
- - **Cloud Provider:** [More Information Needed]
151
- - **Compute Region:** [More Information Needed]
152
- - **Carbon Emitted:** [More Information Needed]
153
-
154
- ## Technical Specifications [optional]
155
-
156
- ### Model Architecture and Objective
157
-
158
- [More Information Needed]
159
-
160
- ### Compute Infrastructure
161
-
162
- [More Information Needed]
163
-
164
- #### Hardware
165
-
166
- [More Information Needed]
167
-
168
- #### Software
169
-
170
- [More Information Needed]
171
-
172
- ## Citation [optional]
173
-
174
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
175
-
176
- **BibTeX:**
177
-
178
- [More Information Needed]
179
-
180
- **APA:**
181
-
182
- [More Information Needed]
183
-
184
- ## Glossary [optional]
185
-
186
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
187
-
188
- [More Information Needed]
189
-
190
- ## More Information [optional]
191
-
192
- [More Information Needed]
193
-
194
- ## Model Card Authors [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Contact
199
-
200
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
  tags:
4
+ - math
5
+ - lora
6
+ - science
7
+ - chemistry
8
+ - biology
9
+ - code
10
+ - text-generation-inference
11
  - unsloth
12
+ license: apache-2.0
13
+ datasets:
14
+ - HuggingFaceTB/smoltalk
15
+ language:
16
+ - en
17
+ base_model:
18
+ - meta-llama/Llama-3.2-1B-Instruct
19
  ---
20
 
21
+ ![FastLlama-Logo](FastLlama.png)
22
 
23
+ These are only LoRA adapters of
24
+ You can use ChatML & Alpaca format.
25
 
26
+ **Overview:**
27
 
28
+ FastLlama is a highly optimized version of the Llama-3.2-1B-Instruct model. Designed for superior performance in constrained environments, it combines speed, compactness, and high accuracy. This version has been fine-tuned using the MetaMathQA-50k section of the HuggingFaceTB/smoltalk dataset to enhance its mathematical reasoning and problem-solving abilities.
29
 
30
+ **Features:**
31
 
32
+ Lightweight and Fast: Optimized to deliver Llama-class capabilities with reduced computational overhead.
33
+ Fine-Tuned for Math Reasoning: Utilizes MetaMathQA-50k for better handling of complex mathematical problems and logical reasoning tasks.
34
+ Instruction-Tuned: Pre-trained on instruction-following tasks, making it robust in understanding and executing detailed queries.
35
+ Versatile Use Cases: Suitable for educational tools, tutoring systems, or any application requiring mathematical reasoning.
36
 
37
+ **Performance Highlights:**
38
 
39
+ Smaller Footprint: The model delivers comparable results to larger counterparts while operating efficiently on smaller hardware.
40
+ Enhanced Accuracy: Demonstrates improved performance on mathematical QA benchmarks.
41
+ Instruction Adherence: Retains high fidelity in understanding and following user instructions, even for complex queries.
42
 
43
+ **Loading the Model:**
44
+ ```py
45
+ import torch
46
+ from transformers import pipeline
 
 
 
47
 
48
+ model_id = "suayptalha/FastLlama-3.2-1B-Instruct"
49
+ pipe = pipeline(
50
+ "text-generation",
51
+ model=model_id,
52
+ torch_dtype=torch.bfloat16,
53
+ device_map="auto",
54
+ )
55
+ messages = [
56
+ {"role": "system", "content": "You are a friendly assistant named FastLlama."},
57
+ {"role": "user", "content": "Who are you?"},
58
+ ]
59
+ outputs = pipe(
60
+ messages,
61
+ max_new_tokens=256,
62
+ )
63
+ print(outputs[0]["generated_text"][-1])
64
+ ```
65
 
66
+ **Dataset:**
67
 
68
+ Dataset: MetaMathQA-50k
69
+ The MetaMathQA-50k subset of HuggingFaceTB/smoltalk was selected for fine-tuning due to its focus on mathematical reasoning, multi-step problem-solving, and logical inference. The dataset includes:
 
70
 
71
+ Algebraic problems
72
+ Geometric reasoning tasks
73
+ Statistical and probabilistic questions
74
+ Logical deduction problems
75
 
76
+ **Model Fine-Tuning:**
77
 
78
+ Fine-tuning was conducted using the following configuration:
79
 
80
+ Learning Rate: 2e-4
81
+ Epochs: 1
82
+ Optimizer: AdamW
83
+ Framework: Unsloth
84
 
85
+ **License:**
86
 
87
+ This model is licensed under the Apache 2.0 License. See the LICENSE file for details.