tteofili commited on
Commit
0fe005d
·
1 Parent(s): 259f03c

Update README.md

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