or4cl3ai commited on
Commit
ad497ea
1 Parent(s): 17c2d8c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +223 -0
README.md CHANGED
@@ -1,3 +1,226 @@
1
  ---
2
  license: openrail
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: openrail
3
+ datasets:
4
+ - the_pile_openwebtext2
5
+ - semeru/code-code-CodeCompletion-TokenLevel-Python
6
+ - pacovaldez/stackoverflow-questions
7
+ - AhmedSSoliman/CodeSearchNet-py
8
+ - irds/codesearchnet
9
+ - bigscience-catalogue-data-dev/lm_code_github-eval_subset
10
+ - codeparrot/github-code
11
+ - nchen909/bigclonebench-processed
12
+ - Open-Orca/OpenOrca
13
+ - fka/awesome-chatgpt-prompts
14
+ - openchat/openchat_sharegpt4_dataset
15
+ - bookcorpus
16
+ - bookcorpusopen
17
+ - nRuaif/OpenOrca-GPT3.5
18
+ language:
19
+ - en
20
+ metrics:
21
+ - accuracy
22
+ - bertscore
23
+ - code_eval
24
+ - f1
25
+ - bleu
26
+ - perplexity
27
+ - mean_iou
28
+ library_name: transformers
29
+ tags:
30
+ - code
31
  ---
32
+ # Model Card for Model ID
33
+
34
+ <!-- Provide a quick summary of what the model is/does. -->
35
+
36
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
37
+
38
+ ## Model Details
39
+
40
+ ### Model Description
41
+
42
+ <!-- Provide a longer summary of what this model is. -->
43
+
44
+
45
+
46
+ - **Developed by:** [More Information Needed]
47
+ - **Shared by [optional]:** [More Information Needed]
48
+ - **Model type:** [More Information Needed]
49
+ - **Language(s) (NLP):** [More Information Needed]
50
+ - **License:** [More Information Needed]
51
+ - **Finetuned from model [optional]:** [More Information Needed]
52
+
53
+ ### Model Sources [optional]
54
+
55
+ <!-- Provide the basic links for the model. -->
56
+
57
+ - **Repository:** [More Information Needed]
58
+ - **Paper [optional]:** [More Information Needed]
59
+ - **Demo [optional]:** [More Information Needed]
60
+
61
+ ## Uses
62
+
63
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
64
+
65
+ ### Direct Use
66
+
67
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
68
+
69
+ [More Information Needed]
70
+
71
+ ### Downstream Use [optional]
72
+
73
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
74
+
75
+ [More Information Needed]
76
+
77
+ ### Out-of-Scope Use
78
+
79
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
80
+
81
+ [More Information Needed]
82
+
83
+ ## Bias, Risks, and Limitations
84
+
85
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
86
+
87
+ [More Information Needed]
88
+
89
+ ### Recommendations
90
+
91
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
92
+
93
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
94
+
95
+ ## How to Get Started with the Model
96
+
97
+ Use the code below to get started with the model.
98
+
99
+ [More Information Needed]
100
+
101
+ ## Training Details
102
+
103
+ ### Training Data
104
+
105
+ <!-- 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. -->
106
+
107
+ [More Information Needed]
108
+
109
+ ### Training Procedure
110
+
111
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
112
+
113
+ #### Preprocessing [optional]
114
+
115
+ [More Information Needed]
116
+
117
+
118
+ #### Training Hyperparameters
119
+
120
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
121
+
122
+ #### Speeds, Sizes, Times [optional]
123
+
124
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
125
+
126
+ [More Information Needed]
127
+
128
+ ## Evaluation
129
+
130
+ <!-- This section describes the evaluation protocols and provides the results. -->
131
+
132
+ ### Testing Data, Factors & Metrics
133
+
134
+ #### Testing Data
135
+
136
+ <!-- This should link to a Data Card if possible. -->
137
+
138
+ [More Information Needed]
139
+
140
+ #### Factors
141
+
142
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
143
+
144
+ [More Information Needed]
145
+
146
+ #### Metrics
147
+
148
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
149
+
150
+ [More Information Needed]
151
+
152
+ ### Results
153
+
154
+ [More Information Needed]
155
+
156
+ #### Summary
157
+
158
+
159
+
160
+ ## Model Examination [optional]
161
+
162
+ <!-- Relevant interpretability work for the model goes here -->
163
+
164
+ [More Information Needed]
165
+
166
+ ## Environmental Impact
167
+
168
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
169
+
170
+ 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).
171
+
172
+ - **Hardware Type:** [More Information Needed]
173
+ - **Hours used:** [More Information Needed]
174
+ - **Cloud Provider:** [More Information Needed]
175
+ - **Compute Region:** [More Information Needed]
176
+ - **Carbon Emitted:** [More Information Needed]
177
+
178
+ ## Technical Specifications [optional]
179
+
180
+ ### Model Architecture and Objective
181
+
182
+ [More Information Needed]
183
+
184
+ ### Compute Infrastructure
185
+
186
+ [More Information Needed]
187
+
188
+ #### Hardware
189
+
190
+ [More Information Needed]
191
+
192
+ #### Software
193
+
194
+ [More Information Needed]
195
+
196
+ ## Citation [optional]
197
+
198
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
199
+
200
+ **BibTeX:**
201
+
202
+ [More Information Needed]
203
+
204
+ **APA:**
205
+
206
+ [More Information Needed]
207
+
208
+ ## Glossary [optional]
209
+
210
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
211
+
212
+ [More Information Needed]
213
+
214
+ ## More Information [optional]
215
+
216
+ [More Information Needed]
217
+
218
+ ## Model Card Authors [optional]
219
+
220
+ [More Information Needed]
221
+
222
+ ## Model Card Contact
223
+
224
+ [More Information Needed]
225
+
226
+