ubayram commited on
Commit
80e5c65
·
verified ·
1 Parent(s): 00f2cf7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +5 -156
README.md CHANGED
@@ -1,22 +1,8 @@
1
- ---
2
- base_model:
3
- - dbmdz/bert-base-turkish-cased
4
- language:
5
- - tr
6
- license: cc
7
- tags:
8
- - misogyny
9
- ---
10
-
11
  # Model Card for Model ID
12
 
13
  <!-- Provide a quick summary of what the model is/does. -->
14
 
15
- 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).
16
-
17
- ## Model Details
18
-
19
- ### Model Description
20
 
21
  <!-- Provide a longer summary of what this model is. -->
22
 
@@ -25,10 +11,10 @@ This modelcard aims to be a base template for new models. It has been generated
25
  - **Developed by:** [More Information Needed]
26
  - **Funded by [optional]:** [More Information Needed]
27
  - **Shared by [optional]:** [More Information Needed]
28
- - **Model type:** [More Information Needed]
29
  - **Language(s) (NLP):** [More Information Needed]
30
- - **License:** [More Information Needed]
31
- - **Finetuned from model [optional]:** [More Information Needed]
32
 
33
  ### Model Sources [optional]
34
 
@@ -38,40 +24,6 @@ This modelcard aims to be a base template for new models. It has been generated
38
  - **Paper [optional]:** [More Information Needed]
39
  - **Demo [optional]:** [More Information Needed]
40
 
41
- ## Uses
42
-
43
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
-
45
- ### Direct Use
46
-
47
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
-
49
- [More Information Needed]
50
-
51
- ### Downstream Use [optional]
52
-
53
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
54
-
55
- [More Information Needed]
56
-
57
- ### Out-of-Scope Use
58
-
59
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
60
-
61
- [More Information Needed]
62
-
63
- ## Bias, Risks, and Limitations
64
-
65
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
66
-
67
- [More Information Needed]
68
-
69
- ### Recommendations
70
-
71
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
72
-
73
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
74
-
75
  ## How to Get Started with the Model
76
 
77
  Use the code below to get started with the model.
@@ -82,96 +34,10 @@ Use the code below to get started with the model.
82
 
83
  ### Training Data
84
 
85
- <!-- 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. -->
86
-
87
- [More Information Needed]
88
-
89
- ### Training Procedure
90
-
91
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
92
-
93
- #### Preprocessing [optional]
94
-
95
- [More Information Needed]
96
-
97
-
98
- #### Training Hyperparameters
99
-
100
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
101
-
102
- #### Speeds, Sizes, Times [optional]
103
-
104
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
105
-
106
- [More Information Needed]
107
-
108
- ## Evaluation
109
-
110
- <!-- This section describes the evaluation protocols and provides the results. -->
111
-
112
- ### Testing Data, Factors & Metrics
113
-
114
- #### Testing Data
115
-
116
- <!-- This should link to a Dataset Card if possible. -->
117
-
118
- [More Information Needed]
119
-
120
- #### Factors
121
-
122
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
123
-
124
- [More Information Needed]
125
-
126
- #### Metrics
127
-
128
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
129
-
130
- [More Information Needed]
131
-
132
- ### Results
133
-
134
- [More Information Needed]
135
-
136
- #### Summary
137
-
138
-
139
-
140
- ## Model Examination [optional]
141
-
142
- <!-- Relevant interpretability work for the model goes here -->
143
-
144
- [More Information Needed]
145
-
146
- ## Environmental Impact
147
-
148
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
149
-
150
- 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).
151
 
152
- - **Hardware Type:** [More Information Needed]
153
- - **Hours used:** [More Information Needed]
154
- - **Cloud Provider:** [More Information Needed]
155
- - **Compute Region:** [More Information Needed]
156
- - **Carbon Emitted:** [More Information Needed]
157
 
158
- ## Technical Specifications [optional]
159
 
160
- ### Model Architecture and Objective
161
-
162
- [More Information Needed]
163
-
164
- ### Compute Infrastructure
165
-
166
- [More Information Needed]
167
-
168
- #### Hardware
169
-
170
- [More Information Needed]
171
-
172
- #### Software
173
-
174
- [More Information Needed]
175
 
176
  ## Citation [optional]
177
 
@@ -185,20 +51,3 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
185
 
186
  [More Information Needed]
187
 
188
- ## Glossary [optional]
189
-
190
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
191
-
192
- [More Information Needed]
193
-
194
- ## More Information [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Authors [optional]
199
-
200
- [More Information Needed]
201
-
202
- ## Model Card Contact
203
-
204
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
1
  # Model Card for Model ID
2
 
3
  <!-- Provide a quick summary of what the model is/does. -->
4
 
5
+ This model is created by fine-tuning the famous BERTurk model that was already pretrained to work on Turkish language.
 
 
 
 
6
 
7
  <!-- Provide a longer summary of what this model is. -->
8
 
 
11
  - **Developed by:** [More Information Needed]
12
  - **Funded by [optional]:** [More Information Needed]
13
  - **Shared by [optional]:** [More Information Needed]
14
+ - **Model type:** Classification
15
  - **Language(s) (NLP):** [More Information Needed]
16
+ - **License:** Creative Commons
17
+ - **Finetuned from model:** BERTurk
18
 
19
  ### Model Sources [optional]
20
 
 
24
  - **Paper [optional]:** [More Information Needed]
25
  - **Demo [optional]:** [More Information Needed]
26
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
27
  ## How to Get Started with the Model
28
 
29
  Use the code below to get started with the model.
 
34
 
35
  ### Training Data
36
 
37
+ To train this model, a private data collection scraped from social media, and then manually labeled by experts is used. The dataset is available to researchers per demand with the conditions of using it only for research purposes and not sharing it with others.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
38
 
 
 
 
 
 
39
 
 
40
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
41
 
42
  ## Citation [optional]
43
 
 
51
 
52
  [More Information Needed]
53