elinas commited on
Commit
fca8bcc
1 Parent(s): 74dd44d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +163 -191
README.md CHANGED
@@ -1,198 +1,170 @@
1
  ---
2
- # For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
3
- # Doc / guide: https://huggingface.co/docs/hub/model-cards
4
- {}
5
  ---
6
 
7
- # Model Card for Model ID
8
 
9
- <!-- Provide a quick summary of what the model is/does. -->
10
 
11
- This is a quantized version of llama-30b
12
-
13
- ## Model Details
14
-
15
- ### Model Description
16
-
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Shared by [optional]:** [More Information Needed]
22
- - **Model type:** [More Information Needed]
23
- - **Language(s) (NLP):** [More Information Needed]
24
- - **License:** [More Information Needed]
25
- - **Finetuned from model [optional]:** [More Information Needed]
26
-
27
- ### Model Sources [optional]
28
-
29
- <!-- Provide the basic links for the model. -->
30
-
31
- - **Repository:** [More Information Needed]
32
-
33
- ## Uses
34
-
35
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
36
-
37
- ### Direct Use
38
-
39
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
40
-
41
- [More Information Needed]
42
-
43
- ### Downstream Use [optional]
44
-
45
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
46
-
47
- [More Information Needed]
48
-
49
- ### Out-of-Scope Use
50
-
51
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
52
-
53
- [More Information Needed]
54
-
55
- ## Bias, Risks, and Limitations
56
-
57
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
58
-
59
- [More Information Needed]
60
-
61
- ### Recommendations
62
-
63
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
64
-
65
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
66
-
67
- ### How to Get Started with the Model
68
-
69
- Use the code below to get started with the model.
70
-
71
- [More Information Needed]
72
-
73
- ## Training Details
74
-
75
- ### Training Data
76
-
77
- <!-- This should link to a Data 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. -->
78
-
79
- [More Information Needed]
80
-
81
- ### Training Procedure
82
-
83
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
84
-
85
- #### Preprocessing [optional]
86
-
87
- [More Information Needed]
88
-
89
-
90
- #### Training Hyperparameters
91
-
92
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
93
-
94
- #### Speeds, Sizes, Times [optional]
95
-
96
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
97
-
98
- [More Information Needed]
99
-
100
- ## Evaluation
101
-
102
- <!-- This section describes the evaluation protocols and provides the results. -->
103
-
104
- ### Testing Data, Factors & Metrics
105
-
106
- #### Testing Data
107
-
108
- <!-- This should link to a Data Card if possible. -->
109
-
110
- [More Information Needed]
111
-
112
- #### Factors
113
-
114
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
115
-
116
- [More Information Needed]
117
-
118
- #### Metrics
119
-
120
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
121
-
122
- [More Information Needed]
123
-
124
- ### Results
125
-
126
- [More Information Needed]
127
-
128
- #### Summary
129
-
130
-
131
-
132
- ## Model Examination [optional]
133
-
134
- <!-- Relevant interpretability work for the model goes here -->
135
-
136
- [More Information Needed]
137
-
138
- ## Environmental Impact
139
-
140
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
141
-
142
- 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).
143
-
144
- - **Hardware Type:** [More Information Needed]
145
- - **Hours used:** [More Information Needed]
146
- - **Cloud Provider:** [More Information Needed]
147
- - **Compute Region:** [More Information Needed]
148
- - **Carbon Emitted:** [More Information Needed]
149
-
150
- ## Technical Specifications [optional]
151
-
152
- ### Model Architecture and Objective
153
-
154
- [More Information Needed]
155
-
156
- ### Compute Infrastructure
157
-
158
- [More Information Needed]
159
-
160
- #### Hardware
161
-
162
- [More Information Needed]
163
-
164
- #### Software
165
-
166
- [More Information Needed]
167
-
168
- ## Citation [optional]
169
-
170
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
171
-
172
- **BibTeX:**
173
-
174
- [More Information Needed]
175
-
176
- **APA:**
177
-
178
- [More Information Needed]
179
-
180
- ## Glossary [optional]
181
-
182
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
183
-
184
- [More Information Needed]
185
-
186
- ## More Information [optional]
187
-
188
- [More Information Needed]
189
-
190
- ## Model Card Authors [optional]
191
-
192
- [More Information Needed]
193
-
194
- ## Model Card Contact
195
-
196
- [More Information Needed]
197
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
198
 
 
1
  ---
2
+ license: other
 
 
3
  ---
4
 
5
+ LLaMA-30B converted to work with Transformers/HuggingFace. This is under a special license, please see the LICENSE file for details.
6
 
7
+ **EXPERIMENTAL RELEASE**
8
 
9
+ This has been converted to int4 via GPTQ method. This requires some special support code that is also highly experimental. NOT COMPATIBLE WITH TRANSFORMERS LIBRARY.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
 
11
+ --
12
+ license: other
13
+ ---
14
+ # LLaMA Model Card
15
+
16
+ ## Model details
17
+ **Organization developing the model**
18
+ The FAIR team of Meta AI.
19
+
20
+ **Model date**
21
+ LLaMA was trained between December. 2022 and Feb. 2023.
22
+
23
+ **Model version**
24
+ This is version 1 of the model.
25
+
26
+ **Model type**
27
+ LLaMA is an auto-regressive language model, based on the transformer architecture. The model comes in different sizes: 7B, 13B, 33B and 65B parameters.
28
+
29
+ **Paper or resources for more information**
30
+ More information can be found in the paper “LLaMA, Open and Efficient Foundation Language Models”, available at https://research.facebook.com/publications/llama-open-and-efficient-foundation-language-models/.
31
+
32
+ **Citations details**
33
+ https://research.facebook.com/publications/llama-open-and-efficient-foundation-language-models/
34
+
35
+ **License**
36
+ Non-commercial bespoke license
37
+
38
+ **Where to send questions or comments about the model**
39
+ Questions and comments about LLaMA can be sent via the [GitHub repository](https://github.com/facebookresearch/llama) of the project , by opening an issue.
40
+
41
+ ## Intended use
42
+ **Primary intended uses**
43
+ The primary use of LLaMA is research on large language models, including:
44
+ exploring potential applications such as question answering, natural language understanding or reading comprehension,
45
+ understanding capabilities and limitations of current language models, and developing techniques to improve those,
46
+ evaluating and mitigating biases, risks, toxic and harmful content generations, hallucinations.
47
+
48
+ **Primary intended users**
49
+ The primary intended users of the model are researchers in natural language processing, machine learning and artificial intelligence.
50
+
51
+ **Out-of-scope use cases**
52
+ LLaMA is a base, or foundational, model. As such, it should not be used on downstream applications without further risk evaluation and mitigation. In particular, our model has not been trained with human feedback, and can thus generate toxic or offensive content, incorrect information or generally unhelpful answers.
53
+
54
+ ## Factors
55
+ **Relevant factors**
56
+ One of the most relevant factors for which model performance may vary is which language is used. Although we included 20 languages in the training data, most of our dataset is made of English text, and we thus expect the model to perform better for English than other languages. Relatedly, it has been shown in previous studies that performance might vary for different dialects, and we expect that it will be the case for our model.
57
+
58
+ **Evaluation factors**
59
+ As our model is trained on data from the Web, we expect that it reflects biases from this source. We thus evaluated on RAI datasets to measure biases exhibited by the model for gender, religion, race, sexual orientation, age, nationality, disability, physical appearance and socio-economic status. We also measure the toxicity of model generations, depending on the toxicity of the context used to prompt the model.
60
+
61
+ ## Metrics
62
+ **Model performance measures**
63
+ We use the following measure to evaluate the model:
64
+ - Accuracy for common sense reasoning, reading comprehension, natural language understanding (MMLU), BIG-bench hard, WinoGender and CrowS-Pairs,
65
+ - Exact match for question answering,
66
+ - The toxicity score from Perspective API on RealToxicityPrompts.
67
+
68
+ **Decision thresholds**
69
+ Not applicable.
70
+
71
+ **Approaches to uncertainty and variability**
72
+ Due to the high computational requirements of training LLMs, we trained only one model of each size, and thus could not evaluate variability of pre-training.
73
+
74
+ ## Evaluation datasets
75
+ The model was evaluated on the following benchmarks: BoolQ, PIQA, SIQA, HellaSwag, WinoGrande, ARC, OpenBookQA, NaturalQuestions, TriviaQA, RACE, MMLU, BIG-bench hard, GSM8k, RealToxicityPrompts, WinoGender, CrowS-Pairs.
76
+
77
+ ## Training dataset
78
+ The model was trained using the following source of data: CCNet [67%], C4 [15%], GitHub [4.5%], Wikipedia [4.5%], Books [4.5%], ArXiv [2.5%], Stack Exchange[2%]. The Wikipedia and Books domains include data in the following languages: bg, ca, cs, da, de, en, es, fr, hr, hu, it, nl, pl, pt, ro, ru, sl, sr, sv, uk. See the paper for more details about the training set and corresponding preprocessing.
79
+
80
+ ## Quantitative analysis
81
+ Hyperparameters for the model architecture
82
+
83
+
84
+ <table>
85
+ <thead>
86
+ <tr>
87
+ <th >LLaMA</th> <th colspan=6>Model hyper parameters </th>
88
+ </tr>
89
+ <tr>
90
+ <th>Number of parameters</th><th>dimension</th><th>n heads</th><th>n layers</th><th>Learn rate</th><th>Batch size</th><th>n tokens</th>
91
+ </tr>
92
+ </thead>
93
+ <tbody>
94
+ <tr>
95
+ <th>7B</th> <th>4096</th> <th>32</th> <th>32</th> <th>3.0E-04</th><th>4M</th><th>1T
96
+ </tr>
97
+ <tr>
98
+ <th>13B</th><th>5120</th><th>40</th><th>40</th><th>3.0E-04</th><th>4M</th><th>1T
99
+ </tr>
100
+ <tr>
101
+ <th>33B</th><th>6656</th><th>52</th><th>60</th><th>1.5.E-04</th><th>4M</th><th>1.4T
102
+ </tr>
103
+ <tr>
104
+ <th>65B</th><th>8192</th><th>64</th><th>80</th><th>1.5.E-04</th><th>4M</th><th>1.4T
105
+ </tr>
106
+ </tbody>
107
+ </table>
108
+
109
+ *Table 1 - Summary of LLama Model Hyperparameters*
110
+
111
+ We present our results on eight standard common sense reasoning benchmarks in the table below.
112
+ <table>
113
+ <thead>
114
+ <tr>
115
+ <th>LLaMA</th> <th colspan=9>Reasoning tasks </th>
116
+ </tr>
117
+ <tr>
118
+ <th>Number of parameters</th> <th>BoolQ</th><th>PIQA</th><th>SIQA</th><th>HellaSwag</th><th>WinoGrande</th><th>ARC-e</th><th>ARC-c</th><th>OBQA</th><th>COPA</th>
119
+ </tr>
120
+ </thead>
121
+ <tbody>
122
+ <tr>
123
+ <th>7B</th><th>76.5</th><th>79.8</th><th>48.9</th><th>76.1</th><th>70.1</th><th>76.7</th><th>47.6</th><th>57.2</th><th>93
124
+ </th>
125
+ <tr><th>13B</th><th>78.1</th><th>80.1</th><th>50.4</th><th>79.2</th><th>73</th><th>78.1</th><th>52.7</th><th>56.4</th><th>94
126
+ </th>
127
+ <tr><th>33B</th><th>83.1</th><th>82.3</th><th>50.4</th><th>82.8</th><th>76</th><th>81.4</th><th>57.8</th><th>58.6</th><th>92
128
+ </th>
129
+ <tr><th>65B</th><th>85.3</th><th>82.8</th><th>52.3</th><th>84.2</th><th>77</th><th>81.5</th><th>56</th><th>60.2</th><th>94</th></tr>
130
+ </tbody>
131
+ </table>
132
+ *Table 2 - Summary of LLama Model Performance on Reasoning tasks*
133
+
134
+
135
+ We present our results on bias in the table below. Note that lower value is better indicating lower bias.
136
+
137
+
138
+ | No | Category | FAIR LLM |
139
+ | --- | -------------------- | -------- |
140
+ | 1 | Gender | 70.6 |
141
+ | 2 | Religion | 79 |
142
+ | 3 | Race/Color | 57 |
143
+ | 4 | Sexual orientation | 81 |
144
+ | 5 | Age | 70.1 |
145
+ | 6 | Nationality | 64.2 |
146
+ | 7 | Disability | 66.7 |
147
+ | 8 | Physical appearance | 77.8 |
148
+ | 9 | Socioeconomic status | 71.5 |
149
+ | | LLaMA Average | 66.6 |
150
+
151
+ *Table 3 - Summary bias of our model output*
152
+
153
+
154
+
155
+ ## Ethical considerations
156
+ **Data**
157
+ The data used to train the model is collected from various sources, mostly from the Web. As such, it contains offensive, harmful and biased content. We thus expect the model to exhibit such biases from the training data.
158
+
159
+ **Human life**
160
+ The model is not intended to inform decisions about matters central to human life, and should not be used in such a way.
161
+
162
+ **Mitigations**
163
+ We filtered the data from the Web based on its proximity to Wikipedia text and references. For this, we used a Kneser-Ney language model and a fastText linear classifier.
164
+
165
+ **Risks and harms**
166
+ Risks and harms of large language models include the generation of harmful, offensive or biased content. These models are often prone to generating incorrect information, sometimes referred to as hallucinations. We do not expect our model to be an exception in this regard.
167
+
168
+ **Use cases**
169
+ LLaMA is a foundational model, and as such, it should not be used for downstream applications without further investigation and mitigations of risks. These risks and potential fraught use cases include, but are not limited to: generation of misinformation and generation of harmful, biased or offensive content.
170