Ranjanunicode commited on
Commit
cbce5ca
1 Parent(s): 17d7e5b

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +221 -0
README.md ADDED
@@ -0,0 +1,221 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: llama2
3
+ language:
4
+ - en
5
+ metrics:
6
+ - perplexity
7
+ ---
8
+
9
+ # Model Card for Model ID
10
+
11
+ <!-- Provide a quick summary of what the model is/does. -->
12
+
13
+ Model Developers Ranjanunicode
14
+
15
+ Quantized version of Llama 2 chat hugging face which can be implemented with minimal hardware requirements.
16
+
17
+ Input Models input text only.
18
+
19
+ Output Models generate text only.
20
+
21
+ ## Model Details
22
+
23
+ ### Model Description
24
+
25
+ <!-- Provide a longer summary of what this model is. -->
26
+
27
+
28
+
29
+ - **Developed by:** Ranjan Pandit
30
+ - **Funded by [optional]:** [More Information Needed]
31
+ - **Shared by [optional]:** [More Information Needed]
32
+ - **Model type:** Quantized version of "meta-llama/Llama-2-7b-chat-hf"
33
+ - **Finetuned from model [optional]:** "meta-llama/Llama-2-7b-chat-hf"
34
+
35
+ ### Model Sources [optional]
36
+
37
+ <!-- Provide the basic links for the model. -->
38
+
39
+ - **Repository:** [More Information Needed]
40
+ - **Paper [optional]:** "https://arxiv.org/abs/2310.19102"
41
+
42
+ ## Uses
43
+
44
+ - Intended Use Cases unicode-llama-2-chat-Hf-q4-2 is intended for commercial and research use in English.
45
+ - Tuned models are intended for assistant-like chat, whereas pretrained models can be adapted for a variety of natural language generation tasks.
46
+ - To get the expected features and performance for the chat versions, a specific formatting needs to be followed,including the INST and <<SYS>> tags, BOS and EOS tokens, and the whitespaces and breaklines in between (we recommend calling strip() on inputs to avoid double-spaces). See our reference code in github for details: chat_completion.
47
+
48
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
49
+
50
+ ### Direct Use
51
+
52
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
53
+
54
+ [More Information Needed]
55
+
56
+ ### Downstream Use [optional]
57
+
58
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
59
+
60
+ [More Information Needed]
61
+
62
+ ### Out-of-Scope Use
63
+
64
+ - Out-of-scope Uses Use in any manner that violates applicable laws or regulations (including trade compliance laws).Use in languages other than English. Use in any other way that is prohibited by the Acceptable Use Policy and Licensing Agreement for Llama 2.
65
+
66
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
67
+
68
+ [More Information Needed]
69
+
70
+ ## Bias, Risks, and Limitations
71
+
72
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
73
+
74
+ [More Information Needed]
75
+
76
+ ### Recommendations
77
+
78
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
79
+
80
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
81
+
82
+ ## How to Get Started with the Model
83
+
84
+ Use the code below to get started with the model.
85
+
86
+ [More Information Needed]
87
+
88
+ ## Training Details
89
+
90
+ ### Training Data
91
+
92
+ <!-- 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. -->
93
+
94
+ [More Information Needed]
95
+
96
+ ### Training Procedure
97
+
98
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
99
+
100
+ #### Preprocessing [optional]
101
+
102
+ [More Information Needed]
103
+
104
+
105
+ #### Training Hyperparameters
106
+
107
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
108
+
109
+ #### Speeds, Sizes, Times [optional]
110
+
111
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
112
+
113
+ [More Information Needed]
114
+
115
+ ## Evaluation
116
+
117
+ - In this section, we report the results for the Llama 1 and Llama 2 models on standard academic benchmarks.For all the evaluations, we use our internal evaluations library.
118
+
119
+ Model Size Code Commonsense Reasoning World Knowledge Reading Comprehension Math MMLU BBH AGI Eval
120
+ Llama 1 7B 14.1 60.8 46.2 58.5 6.95 35.1 30.3 23.9
121
+ Llama 1 13B 18.9 66.1 52.6 62.3 10.9 46.9 37.0 33.9
122
+ Llama 1 33B 26.0 70.0 58.4 67.6 21.4 57.8 39.8 41.7
123
+ Llama 1 65B 30.7 70.7 60.5 68.6 30.8 63.4 43.5 47.6
124
+ Llama 2 7B 16.8 63.9 48.9 61.3 14.6 45.3 32.6 29.3
125
+ Llama 2 13B 24.5 66.9 55.4 65.8 28.7 54.8 39.4 39.1
126
+ Llama 2 70B 37.5 71.9 63.6 69.4 35.2 68.9 51.2 54.2
127
+ <!-- This section describes the evaluation protocols and provides the results. -->
128
+
129
+ ### Testing Data, Factors & Metrics
130
+
131
+ #### Testing Data
132
+
133
+ <!-- This should link to a Dataset Card if possible. -->
134
+
135
+ [More Information Needed]
136
+
137
+ #### Factors
138
+
139
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
140
+
141
+ [More Information Needed]
142
+
143
+ #### Metrics
144
+
145
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
146
+
147
+ [More Information Needed]
148
+
149
+ ### Results
150
+
151
+ [More Information Needed]
152
+
153
+ #### Summary
154
+
155
+
156
+
157
+ ## Model Examination [optional]
158
+
159
+ <!-- Relevant interpretability work for the model goes here -->
160
+
161
+ [More Information Needed]
162
+
163
+ ## Environmental Impact
164
+
165
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
166
+
167
+ 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).
168
+
169
+ - **Hardware Type:** [More Information Needed]
170
+ - **Hours used:** [More Information Needed]
171
+ - **Cloud Provider:** [More Information Needed]
172
+ - **Compute Region:** [More Information Needed]
173
+ - **Carbon Emitted:** [More Information Needed]
174
+
175
+ ## Technical Specifications [optional]
176
+
177
+ ### Model Architecture and Objective
178
+
179
+ [More Information Needed]
180
+
181
+ ### Compute Infrastructure
182
+
183
+ [More Information Needed]
184
+
185
+ #### Hardware
186
+
187
+ [More Information Needed]
188
+
189
+ #### Software
190
+
191
+ [More Information Needed]
192
+
193
+ ## Citation [optional]
194
+
195
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
196
+
197
+ **BibTeX:**
198
+
199
+ [More Information Needed]
200
+
201
+ **APA:**
202
+
203
+ [More Information Needed]
204
+
205
+ ## Glossary [optional]
206
+
207
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
208
+
209
+ [More Information Needed]
210
+
211
+ ## More Information [optional]
212
+
213
+ [More Information Needed]
214
+
215
+ ## Model Card Authors [optional]
216
+
217
+ [More Information Needed]
218
+
219
+ ## Model Card Contact
220
+
221
+ [More Information Needed]