or4cl3ai commited on
Commit
c9ad816
1 Parent(s): 513e58c

Update README.md

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