twhoool02 commited on
Commit
0278cf0
1 Parent(s): 620fd74

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +2 -193
README.md CHANGED
@@ -10,203 +10,12 @@ model_name: Falcon-7B-instruct-NF4
10
  library:
11
  - Transformers
12
  - NF4
13
- arxiv: https://arxiv.org/abs/2305.14314
14
  model_type: falcon
15
  pipeline_tag: text-generation
16
  qunatized_by: twhoool02
17
  ---
18
 
19
- # Model Card for Falcon-7B-instruct-NF4
20
 
21
- <!-- Provide a quick summary of what the model is/does. -->
22
 
23
-
24
-
25
- ## Model Details
26
-
27
- ### Model Description
28
-
29
- <!-- Provide a longer summary of what this model is. -->
30
-
31
- This model is a NF4 quantized version of the meta-llama/Falcon 7B model.
32
-
33
- - **Developed by:** Ted Whooley
34
- - **Funded by [optional]:** [More Information Needed]
35
- - **Shared by [optional]:** [More Information Needed]
36
- - **Model type:** falcon
37
- - **Language(s) (NLP):** en
38
- - **License:** other
39
- - **Finetuned from model [optional]:** tiiuae/falcon-7b-instruct
40
-
41
- ### Model Sources [optional]
42
-
43
- <!-- Provide the basic links for the model. -->
44
-
45
- - **Repository:** [More Information Needed]
46
- - **Paper [optional]:** [More Information Needed]
47
- - **Demo [optional]:** [More Information Needed]
48
-
49
- ## Uses
50
-
51
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
52
-
53
- ### Direct Use
54
-
55
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
56
-
57
- [More Information Needed]
58
-
59
- ### Downstream Use [optional]
60
-
61
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
62
-
63
- [More Information Needed]
64
-
65
- ### Out-of-Scope Use
66
-
67
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
68
-
69
- [More Information Needed]
70
-
71
- ## Bias, Risks, and Limitations
72
-
73
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
74
-
75
- [More Information Needed]
76
-
77
- ### Recommendations
78
-
79
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
80
-
81
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
82
-
83
- ## How to Get Started with the Model
84
-
85
- Use the code below to get started with the model.
86
-
87
- [More Information Needed]
88
-
89
- ## Training Details
90
-
91
- ### Training Data
92
-
93
- <!-- 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. -->
94
-
95
- [More Information Needed]
96
-
97
- ### Training Procedure
98
-
99
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
100
-
101
- #### Preprocessing [optional]
102
-
103
- [More Information Needed]
104
-
105
-
106
- #### Training Hyperparameters
107
-
108
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
109
-
110
- #### Speeds, Sizes, Times [optional]
111
-
112
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
113
-
114
- [More Information Needed]
115
-
116
- ## Evaluation
117
-
118
- <!-- This section describes the evaluation protocols and provides the results. -->
119
-
120
- ### Testing Data, Factors & Metrics
121
-
122
- #### Testing Data
123
-
124
- <!-- This should link to a Dataset Card if possible. -->
125
-
126
- [More Information Needed]
127
-
128
- #### Factors
129
-
130
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
131
-
132
- [More Information Needed]
133
-
134
- #### Metrics
135
-
136
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
137
-
138
- [More Information Needed]
139
-
140
- ### Results
141
-
142
- [More Information Needed]
143
-
144
- #### Summary
145
-
146
-
147
-
148
- ## Model Examination [optional]
149
-
150
- <!-- Relevant interpretability work for the model goes here -->
151
-
152
- [More Information Needed]
153
-
154
- ## Environmental Impact
155
-
156
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
157
-
158
- 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).
159
-
160
- - **Hardware Type:** [More Information Needed]
161
- - **Hours used:** [More Information Needed]
162
- - **Cloud Provider:** [More Information Needed]
163
- - **Compute Region:** [More Information Needed]
164
- - **Carbon Emitted:** [More Information Needed]
165
-
166
- ## Technical Specifications [optional]
167
-
168
- ### Model Architecture and Objective
169
-
170
- [More Information Needed]
171
-
172
- ### Compute Infrastructure
173
-
174
- [More Information Needed]
175
-
176
- #### Hardware
177
-
178
- [More Information Needed]
179
-
180
- #### Software
181
-
182
- [More Information Needed]
183
-
184
- ## Citation [optional]
185
-
186
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
187
-
188
- **BibTeX:**
189
-
190
- [More Information Needed]
191
-
192
- **APA:**
193
-
194
- [More Information Needed]
195
-
196
- ## Glossary [optional]
197
-
198
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
199
-
200
- [More Information Needed]
201
-
202
- ## More Information [optional]
203
-
204
- [More Information Needed]
205
-
206
- ## Model Card Authors [optional]
207
-
208
- [More Information Needed]
209
-
210
- ## Model Card Contact
211
-
212
- [More Information Needed]
 
10
  library:
11
  - Transformers
12
  - NF4
 
13
  model_type: falcon
14
  pipeline_tag: text-generation
15
  qunatized_by: twhoool02
16
  ---
17
 
18
+ # Falcon-7B-instruct-NF4
19
 
20
+ This model is a NF4 quantized version of the tiiuae/falcon-7b-instruct model.
21