nbeerbower commited on
Commit
5217e4f
1 Parent(s): 809cebb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +116 -195
README.md CHANGED
@@ -1,199 +1,120 @@
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
+ base_model:
4
+ - nbeerbower/llama-3-bophades-v3-8B
5
+ datasets:
6
+ - jondurbin/gutenberg-dpo-v0.1
7
+ license: other
8
+ license_name: llama3
9
  ---
10
 
11
+ # llama-3-dragonmaid-8B
12
+
13
+ This model is based on Llama-3-8b, and is governed by [META LLAMA 3 COMMUNITY LICENSE AGREEMENT](LICENSE)
14
+
15
+ [nbeerbower/llama-3-bophades-v3-8B](https://huggingface.co/nbeerbower/llama-3-bophades-v3-8B) finetuned on [jondurbin/gutenberg-dpo-v0.1](https://huggingface.co/datasets/jondurbin/gutenberg-dpo-v0.1).
16
+
17
+ ### Method
18
+
19
+ Finetuned using an A100 on Google Colab.
20
+
21
+ [Fine-Tune Your Own Llama 2 Model in a Colab Notebook](https://mlabonne.github.io/blog/posts/Fine_Tune_Your_Own_Llama_2_Model_in_a_Colab_Notebook.html)
22
+
23
+ ### Configuration
24
+
25
+ Dataset preparation, system prompt:
26
+
27
+ ```python
28
+ def chatml_format(example):
29
+
30
+ # Format instruction
31
+ prompt = "<|im_start|>user\n" + example['prompt'] + "<|im_end|>\n<|im_start|>assistant\n"
32
+
33
+ # Format chosen answer
34
+ chosen = example['chosen'] + "<|im_end|>\n"
35
+
36
+ # Format rejected answer
37
+ rejected = example['rejected'] + "<|im_end|>\n"
38
+
39
+ return {
40
+ "prompt": prompt,
41
+ "chosen": chosen,
42
+ "rejected": rejected,
43
+ }
44
+
45
+ dataset = load_dataset("jondurbin/gutenberg-dpo-v0.1")['train']
46
+
47
+ # Save columns
48
+ original_columns = dataset.column_names
49
+
50
+ # Tokenizer
51
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
52
+ tokenizer.pad_token = tokenizer.eos_token
53
+ tokenizer.padding_side = "left"
54
+
55
+ # Format dataset
56
+ dataset = dataset.map(
57
+ chatml_format,
58
+ remove_columns=original_columns
59
+ )
60
+ ```
61
+
62
+ LoRA, model, and training settings:
63
+
64
+ ```python
65
+ # LoRA configuration
66
+ peft_config = LoraConfig(
67
+ r=16,
68
+ lora_alpha=16,
69
+ lora_dropout=0.05,
70
+ bias="none",
71
+ task_type="CAUSAL_LM",
72
+ target_modules=['k_proj', 'gate_proj', 'v_proj', 'up_proj', 'q_proj', 'o_proj', 'down_proj']
73
+ )
74
+
75
+ # Model to fine-tune
76
+ model = AutoModelForCausalLM.from_pretrained(
77
+ model_name,
78
+ torch_dtype=torch.bfloat16,
79
+ load_in_4bit=True
80
+ )
81
+ model.config.use_cache = False
82
+
83
+ # Reference model
84
+ ref_model = AutoModelForCausalLM.from_pretrained(
85
+ model_name,
86
+ torch_dtype=torch.bfloat16,
87
+ load_in_4bit=True
88
+ )
89
+
90
+ # Training arguments
91
+ training_args = TrainingArguments(
92
+ per_device_train_batch_size=2,
93
+ gradient_accumulation_steps=2,
94
+ gradient_checkpointing=True,
95
+ learning_rate=2e-5,
96
+ lr_scheduler_type="cosine",
97
+ max_steps=1000,
98
+ save_strategy="no",
99
+ logging_steps=1,
100
+ output_dir=new_model,
101
+ optim="paged_adamw_32bit",
102
+ warmup_steps=100,
103
+ bf16=True,
104
+ report_to="wandb",
105
+ )
106
+
107
+ # Create DPO trainer
108
+ dpo_trainer = DPOTrainer(
109
+ model,
110
+ ref_model,
111
+ args=training_args,
112
+ train_dataset=dataset,
113
+ tokenizer=tokenizer,
114
+ peft_config=peft_config,
115
+ beta=0.1,
116
+ max_prompt_length=1024,
117
+ max_length=1536,
118
+ force_use_ref_model=True
119
+ )
120
+ ```