margotwagner commited on
Commit
455b915
·
1 Parent(s): 01fac9a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -105
README.md CHANGED
@@ -19,7 +19,7 @@ tags:
19
 
20
  Pretrained model on English language for text classification. Model trained from [tweet_emotion_eval](https://huggingface.co/elozano/tweet_emotion_eval) ([roberta-base](https://huggingface.co/roberta-base) fine-tuned on emotion task of [tweet_eval](https://huggingface.co/datasets/tweet_eval) dataset) on psychotherapy text transcripts.
21
 
22
- Given a sentence, this model provides a binary classification as either symptomatic or non-symptomatic. Here symptomatic means the sentence displays signs of anxiety and/or depression.
23
 
24
  ## Model Details
25
 
@@ -27,23 +27,12 @@ Given a sentence, this model provides a binary classification as either symptoma
27
 
28
  <!-- Provide a longer summary of what this model is. -->
29
 
30
-
31
-
32
  - **Developed by:** [More Information Needed]
33
- - **Funded by [optional]:** [More Information Needed]
34
- - **Shared by [optional]:** [More Information Needed]
35
- - **Model type:** [More Information Needed]
36
- - **Language(s) (NLP):** [More Information Needed]
37
- - **License:** [More Information Needed]
38
- - **Finetuned from model [optional]:** [More Information Needed]
39
-
40
- ### Model Sources [optional]
41
-
42
- <!-- Provide the basic links for the model. -->
43
-
44
- - **Repository:** [More Information Needed]
45
- - **Paper [optional]:** [More Information Needed]
46
- - **Demo [optional]:** [More Information Needed]
47
 
48
  ## Uses
49
 
@@ -55,30 +44,6 @@ Given a sentence, this model provides a binary classification as either symptoma
55
 
56
  [More Information Needed]
57
 
58
- ### Downstream Use [optional]
59
-
60
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
61
-
62
- [More Information Needed]
63
-
64
- ### Out-of-Scope Use
65
-
66
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
67
-
68
- [More Information Needed]
69
-
70
- ## Bias, Risks, and Limitations
71
-
72
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
73
-
74
- [More Information Needed]
75
-
76
- ### Recommendations
77
-
78
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
79
-
80
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
81
-
82
  ## How to Get Started with the Model
83
 
84
  Use the code below to get started with the model.
@@ -144,70 +109,6 @@ Use the code below to get started with the model.
144
 
145
 
146
 
147
- ## Model Examination [optional]
148
-
149
- <!-- Relevant interpretability work for the model goes here -->
150
-
151
- [More Information Needed]
152
-
153
- ## Environmental Impact
154
-
155
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
156
-
157
- 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).
158
-
159
- - **Hardware Type:** [More Information Needed]
160
- - **Hours used:** [More Information Needed]
161
- - **Cloud Provider:** [More Information Needed]
162
- - **Compute Region:** [More Information Needed]
163
- - **Carbon Emitted:** [More Information Needed]
164
-
165
- ## Technical Specifications [optional]
166
-
167
- ### Model Architecture and Objective
168
-
169
- [More Information Needed]
170
-
171
- ### Compute Infrastructure
172
-
173
- [More Information Needed]
174
-
175
- #### Hardware
176
-
177
- [More Information Needed]
178
-
179
- #### Software
180
-
181
- [More Information Needed]
182
-
183
- ## Citation [optional]
184
-
185
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
186
-
187
- **BibTeX:**
188
-
189
- [More Information Needed]
190
 
191
- **APA:**
192
-
193
- [More Information Needed]
194
-
195
- ## Glossary [optional]
196
-
197
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
198
-
199
- [More Information Needed]
200
-
201
- ## More Information [optional]
202
-
203
- [More Information Needed]
204
-
205
- ## Model Card Authors [optional]
206
-
207
- [More Information Needed]
208
-
209
- ## Model Card Contact
210
-
211
- [More Information Needed]
212
 
213
 
 
19
 
20
  Pretrained model on English language for text classification. Model trained from [tweet_emotion_eval](https://huggingface.co/elozano/tweet_emotion_eval) ([roberta-base](https://huggingface.co/roberta-base) fine-tuned on emotion task of [tweet_eval](https://huggingface.co/datasets/tweet_eval) dataset) on psychotherapy text transcripts.
21
 
22
+ Given a sentence, this model provides a binary classification as either symptomatic or non-symptomatic where symptomatic means the sentence displays signs of anxiety and/or depression.
23
 
24
  ## Model Details
25
 
 
27
 
28
  <!-- Provide a longer summary of what this model is. -->
29
 
 
 
30
  - **Developed by:** [More Information Needed]
31
+ - **Funded by [optional]:** Queen's University
32
+ - **Model type:** RoBERTa
33
+ - **Language(s) (NLP):** English
34
+ - **License:** MIT
35
+ - **Finetuned from model:** [elonzano/tweet_emotion_eval](https://huggingface.co/elozano/tweet_emotion_eval)
 
 
 
 
 
 
 
 
 
36
 
37
  ## Uses
38
 
 
44
 
45
  [More Information Needed]
46
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
  ## How to Get Started with the Model
48
 
49
  Use the code below to get started with the model.
 
109
 
110
 
111
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
112
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
113
 
114