Update README.md
Browse files
README.md
CHANGED
@@ -123,7 +123,7 @@ To train the model, the data needs to be in the following format. Note the data
|
|
123 |
|
124 |
Once the data is in the correct format, QLoRA is recommended. The model can be fine-tuned either using mlx-lm and mps (to tune on an Apple Silicon machine) or a bitsandbytes configuration and cuda (to tune on a machine with Nvidia GPUs).
|
125 |
|
126 |
-
#### Preprocessing
|
127 |
|
128 |
To preprocess your data to be in the correct format outlined above, you can use the following helper function:
|
129 |
|
@@ -177,98 +177,23 @@ If you look at the GitHub repo for this project, mlx_lora.sh includes the comman
|
|
177 |
|
178 |
## Evaluation
|
179 |
|
180 |
-
|
181 |
-
|
182 |
-
### Testing Data, Factors & Metrics
|
183 |
-
|
184 |
-
#### Testing Data
|
185 |
-
|
186 |
-
<!-- This should link to a Dataset Card if possible. -->
|
187 |
-
|
188 |
-
[More Information Needed]
|
189 |
-
|
190 |
-
#### Factors
|
191 |
-
|
192 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
193 |
-
|
194 |
-
[More Information Needed]
|
195 |
-
|
196 |
-
#### Metrics
|
197 |
-
|
198 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
199 |
-
|
200 |
-
[More Information Needed]
|
201 |
|
202 |
### Results
|
203 |
|
204 |
-
|
205 |
-
|
206 |
-
|
207 |
-
|
208 |
-
|
209 |
-
|
210 |
-
|
211 |
-
|
212 |
-
<!-- Relevant interpretability work for the model goes here -->
|
213 |
-
|
214 |
-
[More Information Needed]
|
215 |
-
|
216 |
-
## Environmental Impact
|
217 |
-
|
218 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
219 |
-
|
220 |
-
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).
|
221 |
-
|
222 |
-
- **Hardware Type:** [More Information Needed]
|
223 |
-
- **Hours used:** [More Information Needed]
|
224 |
-
- **Cloud Provider:** [More Information Needed]
|
225 |
-
- **Compute Region:** [More Information Needed]
|
226 |
-
- **Carbon Emitted:** [More Information Needed]
|
227 |
-
|
228 |
-
## Technical Specifications [optional]
|
229 |
-
|
230 |
-
### Model Architecture and Objective
|
231 |
-
|
232 |
-
[More Information Needed]
|
233 |
-
|
234 |
-
### Compute Infrastructure
|
235 |
-
|
236 |
-
[More Information Needed]
|
237 |
-
|
238 |
-
#### Hardware
|
239 |
-
|
240 |
-
[More Information Needed]
|
241 |
-
|
242 |
-
#### Software
|
243 |
-
|
244 |
-
[More Information Needed]
|
245 |
-
|
246 |
-
## Citation [optional]
|
247 |
-
|
248 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
249 |
-
|
250 |
-
**BibTeX:**
|
251 |
-
|
252 |
-
[More Information Needed]
|
253 |
-
|
254 |
-
**APA:**
|
255 |
-
|
256 |
-
[More Information Needed]
|
257 |
-
|
258 |
-
## Glossary [optional]
|
259 |
-
|
260 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
261 |
-
|
262 |
-
[More Information Needed]
|
263 |
-
|
264 |
-
## More Information [optional]
|
265 |
-
|
266 |
-
[More Information Needed]
|
267 |
|
268 |
-
|
269 |
|
270 |
-
|
271 |
|
272 |
## Model Card Contact
|
273 |
|
274 |
-
|
|
|
|
123 |
|
124 |
Once the data is in the correct format, QLoRA is recommended. The model can be fine-tuned either using mlx-lm and mps (to tune on an Apple Silicon machine) or a bitsandbytes configuration and cuda (to tune on a machine with Nvidia GPUs).
|
125 |
|
126 |
+
#### Preprocessing
|
127 |
|
128 |
To preprocess your data to be in the correct format outlined above, you can use the following helper function:
|
129 |
|
|
|
177 |
|
178 |
## Evaluation
|
179 |
|
180 |
+
Testing loss and perplexity were the two metrics used to evaluate the Angora models. A summary of the results for all the different iteration models is included below.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
181 |
|
182 |
### Results
|
183 |
|
184 |
+
| Number of iterations | Testing Loss | Perplexity |
|
185 |
+
|:----------|:----------|:---------|
|
186 |
+
|800 | 0.569 | 1.766 |
|
187 |
+
| 1600 | 0.302 | 1.352 |
|
188 |
+
| 2400 | 0.225 | 1.252 |
|
189 |
+
| 3200 | 0.185 | 1.203 |
|
190 |
+
| 4000 | 0.170 | 1.185 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
191 |
|
192 |
+
### Testing Data
|
193 |
|
194 |
+
The testing data is available [here](https://huggingface.co/datasets/band2001/stolaf-angora/viewer/default/test).
|
195 |
|
196 |
## Model Card Contact
|
197 |
|
198 |
+
Ben Anderson - [ander6@stolaf.edu](mailto:ander6@stolaf.edu)
|
199 |
+
Keegan Murray - murray7@stolaf.edu(mailto:murray7@stolaf.edu)
|