kampkelly commited on
Commit
f4dc264
1 Parent(s): 8ba089c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -159
README.md CHANGED
@@ -77,166 +77,7 @@ print(model_text)
77
 
78
  ```
79
 
80
- ----
81
- ```
82
-
83
- ```
84
-
85
-
86
- [More Information Needed]
87
-
88
- ### Downstream Use [optional]
89
-
90
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
91
-
92
- [More Information Needed]
93
-
94
- ### Out-of-Scope Use
95
-
96
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
97
-
98
- [More Information Needed]
99
-
100
  ## Bias, Risks, and Limitations
101
 
102
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
103
  This model is particularly good for generating SQL `Select` statement queries. Other types of query statements such as Create, Delete, Update, etc are not fully supported.
104
-
105
- [More Information Needed]
106
-
107
- ### Recommendations
108
-
109
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
110
-
111
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
112
-
113
- ## How to Get Started with the Model
114
-
115
- Use the code below to get started with the model.
116
-
117
- [More Information Needed]
118
-
119
- ## Training Details
120
-
121
- ### Training Data
122
-
123
- <!-- 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. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Training Procedure
128
-
129
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
130
-
131
- #### Preprocessing [optional]
132
-
133
- [More Information Needed]
134
-
135
-
136
- #### Training Hyperparameters
137
-
138
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
139
-
140
- #### Speeds, Sizes, Times [optional]
141
-
142
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
143
-
144
- [More Information Needed]
145
-
146
- ## Evaluation
147
-
148
- <!-- This section describes the evaluation protocols and provides the results. -->
149
-
150
- ### Testing Data, Factors & Metrics
151
-
152
- #### Testing Data
153
-
154
- <!-- This should link to a Dataset Card if possible. -->
155
-
156
- [More Information Needed]
157
-
158
- #### Factors
159
-
160
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
161
-
162
- [More Information Needed]
163
-
164
- #### Metrics
165
-
166
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
167
-
168
- [More Information Needed]
169
-
170
- ### Results
171
-
172
- [More Information Needed]
173
-
174
- #### Summary
175
-
176
-
177
-
178
- ## Model Examination [optional]
179
-
180
- <!-- Relevant interpretability work for the model goes here -->
181
-
182
- [More Information Needed]
183
-
184
- ## Environmental Impact
185
-
186
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
187
-
188
- 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).
189
-
190
- - **Hardware Type:** [More Information Needed]
191
- - **Hours used:** [More Information Needed]
192
- - **Cloud Provider:** [More Information Needed]
193
- - **Compute Region:** [More Information Needed]
194
- - **Carbon Emitted:** [More Information Needed]
195
-
196
- ## Technical Specifications [optional]
197
-
198
- ### Model Architecture and Objective
199
-
200
- [More Information Needed]
201
-
202
- ### Compute Infrastructure
203
-
204
- [More Information Needed]
205
-
206
- #### Hardware
207
-
208
- [More Information Needed]
209
-
210
- #### Software
211
-
212
- [More Information Needed]
213
-
214
- ## Citation [optional]
215
-
216
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
217
-
218
- **BibTeX:**
219
-
220
- [More Information Needed]
221
-
222
- **APA:**
223
-
224
- [More Information Needed]
225
-
226
- ## Glossary [optional]
227
-
228
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
229
-
230
- [More Information Needed]
231
-
232
- ## More Information [optional]
233
-
234
- [More Information Needed]
235
-
236
- ## Model Card Authors [optional]
237
-
238
- [More Information Needed]
239
-
240
- ## Model Card Contact
241
-
242
- [More Information Needed]
 
77
 
78
  ```
79
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
80
  ## Bias, Risks, and Limitations
81
 
82
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
83
  This model is particularly good for generating SQL `Select` statement queries. Other types of query statements such as Create, Delete, Update, etc are not fully supported.