LeroyDyer commited on
Commit
bc4b141
1 Parent(s): 50bfb68

Update README.md

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