MaziyarPanahi commited on
Commit
de3ae30
1 Parent(s): 1a0fddc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -187
README.md CHANGED
@@ -28,65 +28,6 @@ tags:
28
  <!-- Provide a quick summary of what the model is/does. -->
29
 
30
 
31
-
32
- ## Model Details
33
-
34
- ### Model Description
35
-
36
- <!-- Provide a longer summary of what this model is. -->
37
-
38
-
39
-
40
- - **Developed by:** [More Information Needed]
41
- - **Funded by [optional]:** [More Information Needed]
42
- - **Shared by [optional]:** [More Information Needed]
43
- - **Model type:** [More Information Needed]
44
- - **Language(s) (NLP):** [More Information Needed]
45
- - **License:** [More Information Needed]
46
- - **Finetuned from model [optional]:** [More Information Needed]
47
-
48
- ### Model Sources [optional]
49
-
50
- <!-- Provide the basic links for the model. -->
51
-
52
- - **Repository:** [More Information Needed]
53
- - **Paper [optional]:** [More Information Needed]
54
- - **Demo [optional]:** [More Information Needed]
55
-
56
- ## Uses
57
-
58
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
59
-
60
- ### Direct Use
61
-
62
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
63
-
64
- [More Information Needed]
65
-
66
- ### Downstream Use [optional]
67
-
68
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
69
-
70
- [More Information Needed]
71
-
72
- ### Out-of-Scope Use
73
-
74
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
75
-
76
- [More Information Needed]
77
-
78
- ## Bias, Risks, and Limitations
79
-
80
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Recommendations
85
-
86
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
87
-
88
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
89
-
90
  ## How to Get Started with the Model
91
 
92
  To use this adapter:
@@ -112,134 +53,19 @@ completes the request.
112
  ### Response:
113
  ```
114
 
115
- [More Information Needed]
116
-
117
- ## Training Details
118
-
119
- ### Training Data
120
-
121
- <!-- 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. -->
122
-
123
- [More Information Needed]
124
-
125
- ### Training Procedure
126
-
127
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
128
-
129
- #### Preprocessing [optional]
130
-
131
- [More Information Needed]
132
-
133
-
134
- #### Training Hyperparameters
135
-
136
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
137
-
138
- #### Speeds, Sizes, Times [optional]
139
-
140
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
141
-
142
- [More Information Needed]
143
-
144
- ## Evaluation
145
-
146
- <!-- This section describes the evaluation protocols and provides the results. -->
147
-
148
- ### Testing Data, Factors & Metrics
149
-
150
- #### Testing Data
151
-
152
- <!-- This should link to a Dataset Card if possible. -->
153
-
154
- [More Information Needed]
155
-
156
- #### Factors
157
-
158
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
159
-
160
- [More Information Needed]
161
-
162
- #### Metrics
163
-
164
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
165
-
166
- [More Information Needed]
167
-
168
- ### Results
169
-
170
- [More Information Needed]
171
-
172
- #### Summary
173
-
174
-
175
-
176
- ## Model Examination [optional]
177
-
178
- <!-- Relevant interpretability work for the model goes here -->
179
-
180
- [More Information Needed]
181
-
182
- ## Environmental Impact
183
-
184
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
185
-
186
- 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).
187
-
188
- - **Hardware Type:** [More Information Needed]
189
- - **Hours used:** [More Information Needed]
190
- - **Cloud Provider:** [More Information Needed]
191
- - **Compute Region:** [More Information Needed]
192
- - **Carbon Emitted:** [More Information Needed]
193
-
194
- ## Technical Specifications [optional]
195
-
196
- ### Model Architecture and Objective
197
-
198
- [More Information Needed]
199
-
200
- ### Compute Infrastructure
201
-
202
- [More Information Needed]
203
-
204
- #### Hardware
205
-
206
- [More Information Needed]
207
-
208
- #### Software
209
-
210
- [More Information Needed]
211
-
212
- ## Citation [optional]
213
-
214
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
215
-
216
- **BibTeX:**
217
-
218
- [More Information Needed]
219
-
220
- **APA:**
221
-
222
- [More Information Needed]
223
-
224
- ## Glossary [optional]
225
-
226
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
227
-
228
- [More Information Needed]
229
-
230
- ## More Information [optional]
231
-
232
- [More Information Needed]
233
-
234
- ## Model Card Authors [optional]
235
-
236
- [More Information Needed]
237
-
238
- ## Model Card Contact
239
-
240
- [More Information Needed]
241
-
242
-
243
  ### Framework versions
244
 
245
  - PEFT 0.7.1
 
28
  <!-- Provide a quick summary of what the model is/does. -->
29
 
30
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
  ## How to Get Started with the Model
32
 
33
  To use this adapter:
 
53
  ### Response:
54
  ```
55
 
56
+ ## Training procedure
57
+
58
+ The following `bitsandbytes` quantization config was used during training:
59
+ - load_in_8bit: False
60
+ - load_in_4bit: True
61
+ - llm_int8_threshold: 6.0
62
+ - llm_int8_skip_modules: None
63
+ - llm_int8_enable_fp32_cpu_offload: False
64
+ - llm_int8_has_fp16_weight: False
65
+ - bnb_4bit_quant_type: nf4
66
+ - bnb_4bit_use_double_quant: True
67
+ - bnb_4bit_compute_dtype: float16
68
+ -
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
  ### Framework versions
70
 
71
  - PEFT 0.7.1