yuriachermann commited on
Commit
8955500
1 Parent(s): 402d00d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +90 -162
README.md CHANGED
@@ -1,199 +1,127 @@
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
+ license: llama3
3
+ library_name: peft
4
+ tags:
5
+ - trl
6
+ - sft
7
+ - generated_from_trainer
8
+ - openassistant-guanaco
9
+ - ipex
10
+ - Gaudi
11
+ base_model: MaziyarPanahi/Llama-3-8B-Instruct-v0.8
12
+ datasets:
13
+ - timdettmers/openassistant-guanaco
14
+ model-index:
15
+ - name: Not-so-bright-AGI-MaziPana-Llama3-8B-v0.8-Guanaco-v1
16
+ results:
17
+ - task:
18
+ type: text-generation
19
+ metrics:
20
+ - name: AI2 Reasoning Challenge
21
+ type: AI2 Reasoning Challenge
22
+ value: 64.68
23
+ - name: HellaSwag
24
+ type: HellaSwag
25
+ value: 81.21
26
+ - name: MMLU
27
+ type: MMLU
28
+ value: 66.16
29
+ - name: TruthfulQA
30
+ type: TruthfulQA
31
+ value: 61.39
32
+ - name: Winogrande
33
+ type: Winogrande
34
+ value: 74.27
35
+ source:
36
+ name: Powered-by-Intel LLM Leaderboard
37
+ url: https://huggingface.co/spaces/Intel/powered_by_intel_llm_leaderboard
38
+ language:
39
+ - en
40
+ metrics:
41
+ - accuracy
42
+ - bertscore
43
+ - bleu
44
+ pipeline_tag: question-answering
45
  ---
46
 
 
47
 
48
+ # Not-so-bright-AGI-MaziPana-Llama3-8B-v0.8-Guanaco-v1
49
 
50
 
51
+ **Model Type:** Fine-Tuned
52
 
53
+ **Model Base:** [MaziyarPanahi/Llama-3-8B-Instruct-v0.8](https://huggingface.co/MaziyarPanahi/Llama-3-8B-Instruct-v0.8)
54
 
55
+ **Datasets Used:** [timdettmers/openassistant-guanaco](https://huggingface.co/datasets/timdettmers/openassistant-guanaco)
56
 
57
+ **Author:** [Yuri Achermann](https://huggingface.co/yuriachermann)
58
 
59
+ **Date:** July 30, 2024
60
 
61
+ -------------------------
 
 
 
 
 
 
62
 
63
+ ## Training procedure
64
 
65
+ ### Training Hyperparameters
66
 
67
+ The following hyperparameters were used during training:
68
+ - learning_rate: 5e-06
69
+ - train_batch_size: 8
70
+ - eval_batch_size: 8
71
+ - seed: 100
72
+ - gradient_accumulation_steps: 4
73
+ - total_train_batch_size: 8
74
+ - optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
75
+ - lr_scheduler_type: linear
76
+ - lr_scheduler_warmup_ratio: 0.05
77
 
78
+ ### Framework versions
79
 
80
+ - PEFT==0.11.1
81
+ - Transformers==4.41.2
82
+ - Pytorch==2.1.0.post0+cxx11.abi
83
+ - Datasets==2.19.2
84
+ - Tokenizers==0.19.1
85
 
86
+ -------------------------
87
 
88
+ ## Intended uses & limitations
89
 
90
+ **Primary Use Case:** The model is intended for generating human-like responses in conversational applications, like chatbots or virtual assistants.
91
 
92
+ **Limitations:** The model may generate inaccurate or biased content as it reflects the data it was trained on. It is essential to evaluate the generated responses in context and use the model responsibly.
93
 
94
+ -------------------------
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
95
 
96
  ## Evaluation
97
 
98
+ The evaluation platform consists of Gaudi Accelerators and Xeon CPUs running benchmarks from the [Eleuther AI Language Model Evaluation Harness](https://github.com/EleutherAI/lm-evaluation-harness)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
99
 
100
+ | Average | ARC | HellaSwag | MMLU | TruthfulQA | Winogrande |
101
+ |:-------:|:-----:|:---------:|:-----:|:----------:|:----------:|
102
+ | 69.162 | 63.99 | 80.95 | 66.04 | 60.17 | 74.66 |
103
 
104
+ -------------------------
105
 
106
+ ## Ethical Considerations
107
 
108
+ The model may inherit biases present in the training data. It is crucial to use the model in a way that promotes fairness and mitigates potential biases.
109
 
110
+ -------------------------
111
 
112
+ ## Acknowledgments
113
 
114
+ This fine-tuning effort was made possible by the support of Intel, that provided the computing resources, and [Eduardo Alvarez](https://huggingface.co/eduardo-alvarez).
115
+ Additional shout-out to the creators of the MaziyarPanahi/Llama-3-8B-Instruct-v0.8 model and the contributors to the timdettmers/openassistant-guanaco dataset.
116
 
117
+ -------------------------
118
 
119
+ ## Contact Information
120
 
121
+ For questions or feedback about this model, please contact **[Yuri Achermann](mailto:yuri.achermann@gmail.com)**.
122
 
123
+ -------------------------
124
 
125
+ ## License
126
 
127
+ This model is distributed under **Apache 2.0 License**.