Update README.md
Browse files
README.md
CHANGED
@@ -1,199 +1,262 @@
|
|
1 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2 |
library_name: transformers
|
3 |
-
|
4 |
---
|
|
|
|
|
5 |
|
6 |
-
#
|
7 |
|
8 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
9 |
|
10 |
|
|
|
11 |
|
12 |
-
|
|
|
13 |
|
14 |
-
### Model Description
|
15 |
|
16 |
-
|
|
|
17 |
|
18 |
-
|
19 |
|
20 |
-
|
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 |
-
###
|
29 |
|
30 |
-
|
|
|
31 |
|
32 |
-
|
33 |
-
- **Paper [optional]:** [More Information Needed]
|
34 |
-
- **Demo [optional]:** [More Information Needed]
|
35 |
|
36 |
-
|
|
|
|
|
|
|
37 |
|
38 |
-
|
|
|
39 |
|
40 |
-
|
|
|
|
|
|
|
|
|
|
|
41 |
|
42 |
-
|
|
|
|
|
43 |
|
44 |
-
|
45 |
|
46 |
-
|
|
|
|
|
|
|
|
|
47 |
|
48 |
-
|
49 |
|
50 |
-
|
|
|
|
|
|
|
51 |
|
52 |
-
|
53 |
|
54 |
-
|
55 |
|
56 |
-
|
57 |
|
58 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
59 |
|
60 |
-
|
61 |
|
62 |
-
|
63 |
-
|
64 |
-
|
65 |
-
|
66 |
-
|
67 |
-
|
68 |
-
|
69 |
-
|
70 |
-
|
71 |
-
|
72 |
-
|
73 |
-
|
74 |
-
|
75 |
-
|
76 |
-
|
77 |
-
|
78 |
-
|
79 |
-
|
80 |
-
|
81 |
-
|
82 |
-
|
83 |
-
|
84 |
-
|
85 |
-
|
86 |
-
|
87 |
-
|
88 |
-
|
89 |
-
|
90 |
-
|
91 |
-
|
92 |
-
|
93 |
-
|
94 |
-
|
95 |
-
|
96 |
-
|
97 |
-
|
98 |
-
|
99 |
-
|
100 |
-
|
101 |
-
|
102 |
-
|
103 |
-
|
104 |
-
|
105 |
-
|
106 |
-
|
107 |
-
|
108 |
-
|
109 |
-
|
110 |
-
|
111 |
-
|
112 |
-
|
113 |
-
|
114 |
-
|
115 |
-
|
116 |
-
|
117 |
-
|
118 |
-
|
119 |
-
|
120 |
-
|
121 |
-
|
122 |
-
|
123 |
-
|
124 |
-
|
125 |
-
|
126 |
-
|
127 |
-
|
128 |
-
|
129 |
-
|
130 |
-
|
131 |
-
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
|
136 |
-
|
137 |
-
|
138 |
-
|
139 |
-
|
140 |
-
|
141 |
-
|
142 |
-
|
143 |
-
|
144 |
-
|
145 |
-
|
146 |
-
|
147 |
-
|
148 |
-
|
149 |
-
|
150 |
-
|
151 |
-
|
152 |
-
|
153 |
-
|
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 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
+
license: cc-by-nc-4.0
|
3 |
+
base_model: google/gemma-7b-it
|
4 |
+
tags:
|
5 |
+
- generated_from_trainer
|
6 |
+
- axolotl
|
7 |
+
- gemma
|
8 |
+
- instruct
|
9 |
+
- finetune
|
10 |
+
- chatml
|
11 |
+
- gpt4
|
12 |
+
- synthetic data
|
13 |
+
- distillation
|
14 |
+
model-index:
|
15 |
+
- name: gemma-7b-openhermes
|
16 |
+
results: []
|
17 |
+
datasets:
|
18 |
+
- mlabonne/chatml-OpenHermes2.5-dpo-binarized-alpha
|
19 |
+
language:
|
20 |
+
- en
|
21 |
library_name: transformers
|
22 |
+
pipeline_tag: text-generation
|
23 |
---
|
24 |
+
<!-- This model card has been generated automatically according to the information the Trainer had access to. You
|
25 |
+
should probably proofread and complete it, then remove this comment. -->
|
26 |
|
27 |
+
# gemma-7b-openhermes
|
28 |
|
|
|
29 |
|
30 |
|
31 |
+
![image/jpeg](https://cdn-uploads.huggingface.co/production/uploads/64e380b2e12618b261fa6ba0/mh-NUO_aNbQpD_NAuFv7g.jpeg)
|
32 |
|
33 |
+
gemma-7b-openhermes is a variant of the Gemma 7B language model, which has been further fine-tuned on the OpenHermes-2.5 preference dataset
|
34 |
+
using QLoRA.
|
35 |
|
|
|
36 |
|
37 |
+
* [google/gemma-7b-it](https://huggingface.co/google/gemma-7b-it)
|
38 |
+
* [mlabonne/chatml-OpenHermes2.5-dpo-binarized-alpha](https://huggingface.co/datasets/mlabonne/chatml-OpenHermes2.5-dpo-binarized-alpha)
|
39 |
|
40 |
+
</details><br>
|
41 |
|
42 |
+
## Usage
|
|
|
|
|
|
|
|
|
|
|
|
|
43 |
|
44 |
+
### Chat Template
|
45 |
|
46 |
+
The instruction-tuned models use a chat template that must be adhered to for conversational use.
|
47 |
+
The easiest way to apply it is using the tokenizer's built-in chat template, as shown in the following snippet.
|
48 |
|
49 |
+
Let's load the model and apply the chat template to a conversation. In this example, we'll start with a single user interaction:
|
|
|
|
|
50 |
|
51 |
+
```py
|
52 |
+
from transformers import AutoTokenizer, AutoModelForCausalLM
|
53 |
+
import transformers
|
54 |
+
import torch
|
55 |
|
56 |
+
model_id = "abideen/gemma-7b-openhermes"
|
57 |
+
dtype = torch.bfloat16
|
58 |
|
59 |
+
tokenizer = AutoTokenizer.from_pretrained(model_id)
|
60 |
+
model = AutoModelForCausalLM.from_pretrained(
|
61 |
+
model_id,
|
62 |
+
device_map="cuda",
|
63 |
+
torch_dtype=dtype,
|
64 |
+
)
|
65 |
|
66 |
+
chat = [{ "role": "user", "content": "What is a Language Model?" }]
|
67 |
+
prompt = tokenizer.apply_chat_template(chat, tokenize=False, add_generation_prompt=True)
|
68 |
+
```
|
69 |
|
70 |
+
After the prompt is ready, generation can be performed like this:
|
71 |
|
72 |
+
```py
|
73 |
+
inputs = tokenizer.encode(prompt, add_special_tokens=True, return_tensors="pt")
|
74 |
+
outputs = model.generate(input_ids=inputs.to(model.device), max_new_tokens=250)
|
75 |
+
print(tokenizer.decode(outputs[0]))
|
76 |
+
```
|
77 |
|
78 |
+
### Inputs and outputs
|
79 |
|
80 |
+
* **Input:** Text string, such as a question, a prompt, or a document to be
|
81 |
+
summarized.
|
82 |
+
* **Output:** Generated English-language text in response to the input, such
|
83 |
+
as an answer to a question, or a summary of a document.
|
84 |
|
85 |
+
## 🏆 Evaluation results
|
86 |
|
87 |
+
# Nous Benchmark
|
88 |
|
89 |
+
Agieval
|
90 |
|
91 |
+
| Task | Version | Metric | Value | | StdErr |
|
92 |
+
|-------------------------------------------|---------|--------|-------|---|---------|
|
93 |
+
| agieval\_aqua\_rat | 0 | acc | 24.80 | _ | 2.72 |
|
94 |
+
| agieval\_aqua\_rat | 0 | acc\_norm | 24.80 | _ | 2.72 |
|
95 |
+
| agieval\_logiqa\_en | 0 | acc | 20.89 | _ | 1.59 |
|
96 |
+
| agieval\_logiqa\_en | 0 | acc\_norm | 23.35 | _ | 1.66 |
|
97 |
+
| agieval\_lsat\_ar | 0 | acc | 21.74 | _ | 2.73 |
|
98 |
+
| agieval\_lsat\_ar | 0 | acc\_norm | 20.43 | _ | 2.66 |
|
99 |
+
| agieval\_lsat\_lr | 0 | acc | 15.49 | _ | 1.60 |
|
100 |
+
| agieval\_lsat\_lr | 0 | acc\_norm | 20.59 | _ | 1.79 |
|
101 |
+
| agieval\_lsat\_rc | 0 | acc | 17.10 | _ | 2.30 |
|
102 |
+
| agieval\_lsat\_rc | 0 | acc\_norm | 17.84 | _ | 2.34 |
|
103 |
+
| agieval\_sat\_en | 0 | acc | 29.61 | _ | 3.19 |
|
104 |
+
| agieval\_sat\_en | 0 | acc\_norm | 29.61 | _ | 3.19 |
|
105 |
+
| agieval\_sat\_en\_without\_passage | 0 | acc | 26.21 | _ | 3.07 |
|
106 |
+
| agieval\_sat\_en\_without\_passage | 0 | acc\_norm | 24.76 | _ | 3.01 |
|
107 |
+
| agieval\_sat\_math | 0 | acc | 22.73 | _ | 2.83 |
|
108 |
+
| agieval\_sat\_math | 0 | acc\_norm | 22.73 | _ | 2.83 |
|
109 |
+
Average: 22.29
|
110 |
|
111 |
+
GPT4ALL
|
112 |
|
113 |
+
| Task | Version | Metric | Value | | StdErr |
|
114 |
+
|---------------|---------|------------|---------|---|-------------|
|
115 |
+
| arc_challenge | 0 | acc | 20.14 | _ | 1.17 |
|
116 |
+
| arc_challenge | 0 | acc_norm | 22.87 | _ | 1.23 |
|
117 |
+
| arc_easy | 0 | acc | 32.37 | _ | 0.96 |
|
118 |
+
| arc_easy | 0 | acc_norm | 31.61 | _ | 0.95 |
|
119 |
+
| boolq | 1 | acc | 45.78 | _ | 0.87 |
|
120 |
+
| hellaswag | 0 | acc | 32.03 | _ | 0.47 |
|
121 |
+
| hellaswag | 0 | acc_norm | 35.18 | _ | 0.48 |
|
122 |
+
| openbookqa | 0 | acc | 17.8 | _ | 1.71 |
|
123 |
+
| openbookqa | 0 | acc_norm | 29.8 | _ | 2.05 |
|
124 |
+
| piqa | 0 | acc | 54.46 | _ | 1.16 |
|
125 |
+
| piqa | 0 | acc_norm | 54.57 | _ | 1.16 |
|
126 |
+
| winogrande | 0 | acc | 48.30 | _ | 1.40 |
|
127 |
+
Average: 32.00
|
128 |
+
|
129 |
+
|
130 |
+
TruthfulQA
|
131 |
+
|
132 |
+
| Task | Version | Metric | Value | Std Err |
|
133 |
+
|----------------------------------|---------|--------|--------|----------|
|
134 |
+
| truthfulqa\_mc | 1 | mc1 | 30.11 | 1.61 |
|
135 |
+
| truthfulqa\_mc | 1 | mc2 | 47.69 | 1.61 |
|
136 |
+
Average: 38.90
|
137 |
+
|
138 |
+
|
139 |
+
# Openllm Benchmark
|
140 |
+
|
141 |
+
| Task |Version| Metric |Value| |Stderr|
|
142 |
+
|-------------|------:|--------|----:|---|-----:|
|
143 |
+
|arc_challenge| 0|acc |48.12|± | 1.46|
|
144 |
+
| | |acc_norm|51.27|± | 1.46|
|
145 |
+
|hellaswag | 0|acc |55.4 |± | 0.49|
|
146 |
+
| | |acc_norm|71.92|± | 0.42|
|
147 |
+
|gsm8k | 0|acc |29.87|± | 1.2 |
|
148 |
+
|winogrande | 0|acc |68.19|± | 1.3 |
|
149 |
+
|mmlu | 0|acc |53.62 |±| 0.6 |
|
150 |
+
|
151 |
+
Average: 73.5%
|
152 |
+
|
153 |
+
### TruthfulQA
|
154 |
+
| Task |Version|Metric|Value| |Stderr|
|
155 |
+
|-------------|------:|------|----:|---|-----:|
|
156 |
+
|truthfulqa_mc| 1|mc1 |30.23|± | 1.60|
|
157 |
+
| | |mc2 |47.17|± | 1.63|
|
158 |
+
|
159 |
+
|
160 |
+
|
161 |
+
### Training hyperparameters
|
162 |
+
|
163 |
+
The following hyperparameters were used during training:
|
164 |
+
- learning_rate: 5e-07
|
165 |
+
- train_batch_size: 1
|
166 |
+
- eval_batch_size: 8
|
167 |
+
- seed: 42
|
168 |
+
- gradient_accumulation_steps: 8
|
169 |
+
- total_train_batch_size: 8
|
170 |
+
- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
|
171 |
+
- lr_scheduler_type: cosine
|
172 |
+
- lr_scheduler_warmup_steps: 100
|
173 |
+
- training_steps: 1000
|
174 |
+
|
175 |
+
|
176 |
+
### 📝 Axolotl Configuration
|
177 |
+
|
178 |
+
```yaml
|
179 |
+
base_model: google/gemma-7b-it
|
180 |
+
model_type: GemmaForCausalLM
|
181 |
+
tokenizer_type: GemmaTokenizer
|
182 |
+
trust_remote_code: true
|
183 |
+
|
184 |
+
load_in_8bit: false
|
185 |
+
load_in_4bit: true
|
186 |
+
strict: false
|
187 |
+
|
188 |
+
rl: dpo
|
189 |
+
chat_template: chatml
|
190 |
+
datasets:
|
191 |
+
- path: mlabonne/chatml-OpenHermes2.5-dpo-binarized-alpha
|
192 |
+
split: train
|
193 |
+
type: chatml.intel
|
194 |
+
dataset_prepared_path:
|
195 |
+
val_set_size: 0.01
|
196 |
+
output_dir: ./out
|
197 |
+
|
198 |
+
adapter: qlora
|
199 |
+
lora_model_dir:
|
200 |
+
|
201 |
+
sequence_len: 1800
|
202 |
+
sample_packing: false
|
203 |
+
pad_to_sequence_len: false
|
204 |
+
|
205 |
+
lora_r: 16
|
206 |
+
lora_alpha: 16
|
207 |
+
lora_dropout: 0.05
|
208 |
+
lora_target_linear: true
|
209 |
+
lora_fan_in_fan_out:
|
210 |
+
lora_target_modules:
|
211 |
+
|
212 |
+
wandb_project: gemma
|
213 |
+
wandb_entity:
|
214 |
+
wandb_watch:
|
215 |
+
wandb_name:
|
216 |
+
wandb_log_model:
|
217 |
+
|
218 |
+
gradient_accumulation_steps: 8
|
219 |
+
micro_batch_size: 1
|
220 |
+
num_epochs: 1
|
221 |
+
optimizer: paged_adamw_32bit
|
222 |
+
lr_scheduler: cosine
|
223 |
+
learning_rate: 5e-7
|
224 |
+
|
225 |
+
train_on_inputs: false
|
226 |
+
group_by_length: false
|
227 |
+
bf16: true
|
228 |
+
fp16: false
|
229 |
+
tf32: true
|
230 |
+
|
231 |
+
gradient_checkpointing: true
|
232 |
+
early_stopping_patience:
|
233 |
+
resume_from_checkpoint:
|
234 |
+
local_rank:
|
235 |
+
logging_steps: 1
|
236 |
+
xformers_attention:
|
237 |
+
flash_attention: false
|
238 |
+
|
239 |
+
warmup_steps: 100
|
240 |
+
evals_per_epoch: 1
|
241 |
+
eval_table_size:
|
242 |
+
eval_table_max_new_tokens: 128
|
243 |
+
save_steps: 1000
|
244 |
+
max_steps: 1000
|
245 |
+
debug:
|
246 |
+
deepspeed:
|
247 |
+
weight_decay: 0.0
|
248 |
+
fsdp:
|
249 |
+
fsdp_config:
|
250 |
+
special_tokens:
|
251 |
+
```
|
252 |
+
|
253 |
+
|
254 |
+
### Framework versions
|
255 |
+
|
256 |
+
- Transformers 4.39.0.dev0
|
257 |
+
- Pytorch 2.1.2+cu118
|
258 |
+
- Datasets 2.17.0
|
259 |
+
- Tokenizers 0.15.0
|
260 |
+
- axolotl: 0.4.0
|
261 |
+
|
262 |
+
[<img src="https://raw.githubusercontent.com/OpenAccess-AI-Collective/axolotl/main/image/axolotl-badge-web.png" alt="Built with Axolotl" width="200" height="32"/>](https://github.com/OpenAccess-AI-Collective/axolotl)
|