tricktreat commited on
Commit
d26ec7d
1 Parent(s): 8f871af

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +228 -0
README.md ADDED
@@ -0,0 +1,228 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ datasets:
4
+ - timdettmers/openassistant-guanaco
5
+ library_name: adapter-transformers
6
+ ---
7
+
8
+ ## Hyperparameter
9
+
10
+ ```bash
11
+ deepspeed --include=node-0:2 sft_fix_target_modules.py --deepspeed dp_zero0.json \
12
+ --model_name_or_path="guanaco_Llama-2-7b-chat-hf_freeze_embed_tokens_q_v_proj" \
13
+ --dataset_name="timdettmers/openassistant-guanaco" \
14
+ --dataset_text_field="text" \
15
+ --report_to="tensorboard" \
16
+ --learning_rate=1e-5 \
17
+ --per_device_train_batch_size=32 \
18
+ --gradient_accumulation_steps=4 \
19
+ --output_dir="guanaco_Llama-2-7b-chat-hf_freeze_embed_tokens_q_v_proj_lora" \
20
+ --logging_steps=1 \
21
+ --num_train_epochs=15 \
22
+ --max_steps=-1 \
23
+ --gradient_checkpointing \
24
+ --fp16 \
25
+ --save_steps=0.3 \
26
+ --use_peft \
27
+ --lora_r=64 \
28
+ --lora_alpha=16
29
+ ```
30
+
31
+ ## Dataset
32
+
33
+ `timdettmers/openassistant-guanaco`
34
+
35
+ # Model Card for Model ID
36
+
37
+ <!-- Provide a quick summary of what the model is/does. -->
38
+
39
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
40
+
41
+ ## Model Details
42
+
43
+ ### Model Description
44
+
45
+ <!-- Provide a longer summary of what this model is. -->
46
+
47
+
48
+
49
+ - **Developed by:** [More Information Needed]
50
+ - **Funded by [optional]:** [More Information Needed]
51
+ - **Shared by [optional]:** [More Information Needed]
52
+ - **Model type:** [More Information Needed]
53
+ - **Language(s) (NLP):** [More Information Needed]
54
+ - **License:** [More Information Needed]
55
+ - **Finetuned from model [optional]:** [More Information Needed]
56
+
57
+ ### Model Sources [optional]
58
+
59
+ <!-- Provide the basic links for the model. -->
60
+
61
+ - **Repository:** [More Information Needed]
62
+ - **Paper [optional]:** [More Information Needed]
63
+ - **Demo [optional]:** [More Information Needed]
64
+
65
+ ## Uses
66
+
67
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
68
+
69
+ ### Direct Use
70
+
71
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
72
+
73
+ [More Information Needed]
74
+
75
+ ### Downstream Use [optional]
76
+
77
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
78
+
79
+ [More Information Needed]
80
+
81
+ ### Out-of-Scope Use
82
+
83
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
84
+
85
+ [More Information Needed]
86
+
87
+ ## Bias, Risks, and Limitations
88
+
89
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
90
+
91
+ [More Information Needed]
92
+
93
+ ### Recommendations
94
+
95
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
96
+
97
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
98
+
99
+ ## How to Get Started with the Model
100
+
101
+ Use the code below to get started with the model.
102
+
103
+ [More Information Needed]
104
+
105
+ ## Training Details
106
+
107
+ ### Training Data
108
+
109
+ <!-- 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. -->
110
+
111
+ [More Information Needed]
112
+
113
+ ### Training Procedure
114
+
115
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
116
+
117
+ #### Preprocessing [optional]
118
+
119
+ [More Information Needed]
120
+
121
+
122
+ #### Training Hyperparameters
123
+
124
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
125
+
126
+ #### Speeds, Sizes, Times [optional]
127
+
128
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
129
+
130
+ [More Information Needed]
131
+
132
+ ## Evaluation
133
+
134
+ <!-- This section describes the evaluation protocols and provides the results. -->
135
+
136
+ ### Testing Data, Factors & Metrics
137
+
138
+ #### Testing Data
139
+
140
+ <!-- This should link to a Dataset Card if possible. -->
141
+
142
+ [More Information Needed]
143
+
144
+ #### Factors
145
+
146
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
147
+
148
+ [More Information Needed]
149
+
150
+ #### Metrics
151
+
152
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
153
+
154
+ [More Information Needed]
155
+
156
+ ### Results
157
+
158
+ [More Information Needed]
159
+
160
+ #### Summary
161
+
162
+
163
+
164
+ ## Model Examination [optional]
165
+
166
+ <!-- Relevant interpretability work for the model goes here -->
167
+
168
+ [More Information Needed]
169
+
170
+ ## Environmental Impact
171
+
172
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
173
+
174
+ 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).
175
+
176
+ - **Hardware Type:** [More Information Needed]
177
+ - **Hours used:** [More Information Needed]
178
+ - **Cloud Provider:** [More Information Needed]
179
+ - **Compute Region:** [More Information Needed]
180
+ - **Carbon Emitted:** [More Information Needed]
181
+
182
+ ## Technical Specifications [optional]
183
+
184
+ ### Model Architecture and Objective
185
+
186
+ [More Information Needed]
187
+
188
+ ### Compute Infrastructure
189
+
190
+ [More Information Needed]
191
+
192
+ #### Hardware
193
+
194
+ [More Information Needed]
195
+
196
+ #### Software
197
+
198
+ [More Information Needed]
199
+
200
+ ## Citation [optional]
201
+
202
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
203
+
204
+ **BibTeX:**
205
+
206
+ [More Information Needed]
207
+
208
+ **APA:**
209
+
210
+ [More Information Needed]
211
+
212
+ ## Glossary [optional]
213
+
214
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
215
+
216
+ [More Information Needed]
217
+
218
+ ## More Information [optional]
219
+
220
+ [More Information Needed]
221
+
222
+ ## Model Card Authors [optional]
223
+
224
+ [More Information Needed]
225
+
226
+ ## Model Card Contact
227
+
228
+ [More Information Needed]