stulcrad commited on
Commit
639234e
1 Parent(s): 70f6f34

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +164 -0
README.md CHANGED
@@ -47,4 +47,168 @@ configs:
47
  path: data/validation-*
48
  - split: test
49
  path: data/test-*
 
 
50
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
  path: data/validation-*
48
  - split: test
49
  path: data/test-*
50
+ language:
51
+ - cs
52
  ---
53
+ # Dataset Card for Dataset Name
54
+
55
+ <!-- Provide a quick summary of the dataset. -->
56
+
57
+ This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
58
+
59
+ ## Dataset Details
60
+
61
+ ### Dataset Description
62
+
63
+ This dataset contains the CoNLL-based Extended Czech Named Entity Corpus 2.0 (CNEC 2.0_extended).
64
+ The dataset is a collection of Czech texts annotated with named entities.
65
+ The original CNEC 2.0 dataset contains 8993 Czech sentences with 35220 Czech named entities (train + validation + test).
66
+ The original corpus uses 58 entity types.
67
+ The extended version uses only 7 entity types and one additional type for non-entities:
68
+ - 'O' = Outside of a named entity
69
+ - 'B-A' = Beginning of a complex address number (Postal code, street number, even phone number)
70
+ - 'I-A' = Inside of a number in the address
71
+ - 'B-G' = Beginning of a geographical name
72
+ - 'I-G' = Inside of a geographical name
73
+ - 'B-I' = Beginning of an institution name
74
+ - 'I-I' = Inside of an institution name
75
+ - 'B-M' = Beginning of a media name (email, server, website, tv series, etc.)
76
+ - 'I-M' = Inside of a media name
77
+ - 'B-O' = Beginning of an artifact name (book, old movies, etc.)
78
+ - 'I-O' = Inside of an artifact name
79
+ - 'B-P' = Beginning of a person's name
80
+ - 'I-P' = Inside of a person's name
81
+ - 'B-T' = Beginning of a time expression
82
+ - 'I-T' = Inside of a time expression
83
+
84
+ ### Dataset Sources [optional]
85
+
86
+ <!-- Provide the basic links for the dataset. -->
87
+
88
+ - **Repository:** [More Information Needed]
89
+ - **Paper [optional]:** [More Information Needed]
90
+ - **Demo [optional]:** [More Information Needed]
91
+
92
+ ## Uses
93
+
94
+ <!-- Address questions around how the dataset is intended to be used. -->
95
+
96
+ ### Direct Use
97
+
98
+ <!-- This section describes suitable use cases for the dataset. -->
99
+
100
+ [More Information Needed]
101
+
102
+ ### Out-of-Scope Use
103
+
104
+ <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
105
+
106
+ [More Information Needed]
107
+
108
+ ## Dataset Structure
109
+
110
+ <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
111
+
112
+ [More Information Needed]
113
+
114
+ ## Dataset Creation
115
+
116
+ ### Curation Rationale
117
+
118
+ <!-- Motivation for the creation of this dataset. -->
119
+
120
+ [More Information Needed]
121
+
122
+ ### Source Data
123
+
124
+ <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
125
+
126
+ #### Data Collection and Processing
127
+
128
+ <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
129
+
130
+ [More Information Needed]
131
+
132
+ #### Who are the source data producers?
133
+
134
+ "http://hdl.handle.net/11234/1-3493"
135
+
136
+ [More Information Needed]
137
+
138
+ ### Annotations [optional]
139
+
140
+ <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
141
+
142
+ #### Annotation process
143
+
144
+ <!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
145
+
146
+ [More Information Needed]
147
+
148
+ #### Who are the annotators?
149
+
150
+ <!-- This section describes the people or systems who created the annotations. -->
151
+
152
+ [More Information Needed]
153
+
154
+ #### Personal and Sensitive Information
155
+
156
+ <!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
157
+
158
+ [More Information Needed]
159
+
160
+ ## Bias, Risks, and Limitations
161
+
162
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
163
+
164
+ [More Information Needed]
165
+
166
+ ### Recommendations
167
+
168
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
169
+
170
+ Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
171
+
172
+ ## Citation [optional]
173
+
174
+ <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
175
+
176
+ **BibTeX:**
177
+
178
+ @misc{11234/1-3493,
179
+ title = {{CoNLL}-based Extended Czech Named Entity Corpus 2.0},
180
+ author = {Konkol, Michal and Konop{\'{\i}}k, Miloslav and {\v S}ev{\v c}{\'{\i}}kov{\'a}, Magda and {\v Z}abokrtsk{\'y}, Zden{\v e}k and Strakov{\'a}, Jana and Straka, Milan},
181
+ url = {http://hdl.handle.net/11234/1-3493},
182
+ note = {{LINDAT}/{CLARIAH}-{CZ} digital library at the Institute of Formal and Applied Linguistics ({{\'U}FAL}), Faculty of Mathematics and Physics, Charles University},
183
+ copyright = {Attribution-{NonCommercial}-{ShareAlike} 3.0 Unported ({CC} {BY}-{NC}-{SA} 3.0)},
184
+ year = {2014} }
185
+
186
+ @misc{11858/00-097C-0000-0023-1B22-8,
187
+ title = {Czech Named Entity Corpus 2.0},
188
+ author = {{\v S}ev{\v c}{\'{\i}}kov{\'a}, Magda and {\v Z}abokrtsk{\'y}, Zden{\v e}k and Strakov{\'a}, Jana and Straka, Milan},
189
+ url = {http://hdl.handle.net/11858/00-097C-0000-0023-1B22-8},
190
+ note = {{LINDAT}/{CLARIAH}-{CZ} digital library at the Institute of Formal and Applied Linguistics ({{\'U}FAL}), Faculty of Mathematics and Physics, Charles University},
191
+ copyright = {Attribution-{NonCommercial}-{ShareAlike} 3.0 Unported ({CC} {BY}-{NC}-{SA} 3.0)},
192
+ year = {2014} }
193
+
194
+ **APA:**
195
+
196
+ [More Information Needed]
197
+
198
+ ## Glossary [optional]
199
+
200
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
201
+
202
+ [More Information Needed]
203
+
204
+ ## More Information [optional]
205
+
206
+ [More Information Needed]
207
+
208
+ ## Dataset Card Authors [optional]
209
+
210
+ [More Information Needed]
211
+
212
+ ## Dataset Card Contact
213
+
214
+ [More Information Needed]