maxmarcon commited on
Commit
444c48c
·
verified ·
1 Parent(s): c7035b4

Upload README.md with huggingface_hub

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