Jason-ice-SCUT commited on
Commit
88fd123
·
verified ·
1 Parent(s): e858738

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +196 -363
README.md CHANGED
@@ -1,365 +1,198 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: url
5
- dtype: string
6
- - name: repository_url
7
- dtype: string
8
- - name: labels_url
9
- dtype: string
10
- - name: comments_url
11
- dtype: string
12
- - name: events_url
13
- dtype: string
14
- - name: html_url
15
- dtype: string
16
- - name: id
17
- dtype: int64
18
- - name: node_id
19
- dtype: string
20
- - name: number
21
- dtype: int64
22
- - name: title
23
- dtype: string
24
- - name: user
25
- struct:
26
- - name: avatar_url
27
- dtype: string
28
- - name: events_url
29
- dtype: string
30
- - name: followers_url
31
- dtype: string
32
- - name: following_url
33
- dtype: string
34
- - name: gists_url
35
- dtype: string
36
- - name: gravatar_id
37
- dtype: string
38
- - name: html_url
39
- dtype: string
40
- - name: id
41
- dtype: int64
42
- - name: login
43
- dtype: string
44
- - name: node_id
45
- dtype: string
46
- - name: organizations_url
47
- dtype: string
48
- - name: received_events_url
49
- dtype: string
50
- - name: repos_url
51
- dtype: string
52
- - name: site_admin
53
- dtype: bool
54
- - name: starred_url
55
- dtype: string
56
- - name: subscriptions_url
57
- dtype: string
58
- - name: type
59
- dtype: string
60
- - name: url
61
- dtype: string
62
- - name: user_view_type
63
- dtype: string
64
- - name: labels
65
- list:
66
- - name: color
67
- dtype: string
68
- - name: default
69
- dtype: bool
70
- - name: description
71
- dtype: string
72
- - name: id
73
- dtype: int64
74
- - name: name
75
- dtype: string
76
- - name: node_id
77
- dtype: string
78
- - name: url
79
- dtype: string
80
- - name: state
81
- dtype: string
82
- - name: locked
83
- dtype: bool
84
- - name: assignee
85
- struct:
86
- - name: avatar_url
87
- dtype: string
88
- - name: events_url
89
- dtype: string
90
- - name: followers_url
91
- dtype: string
92
- - name: following_url
93
- dtype: string
94
- - name: gists_url
95
- dtype: string
96
- - name: gravatar_id
97
- dtype: string
98
- - name: html_url
99
- dtype: string
100
- - name: id
101
- dtype: int64
102
- - name: login
103
- dtype: string
104
- - name: node_id
105
- dtype: string
106
- - name: organizations_url
107
- dtype: string
108
- - name: received_events_url
109
- dtype: string
110
- - name: repos_url
111
- dtype: string
112
- - name: site_admin
113
- dtype: bool
114
- - name: starred_url
115
- dtype: string
116
- - name: subscriptions_url
117
- dtype: string
118
- - name: type
119
- dtype: string
120
- - name: url
121
- dtype: string
122
- - name: user_view_type
123
- dtype: string
124
- - name: assignees
125
- list:
126
- - name: avatar_url
127
- dtype: string
128
- - name: events_url
129
- dtype: string
130
- - name: followers_url
131
- dtype: string
132
- - name: following_url
133
- dtype: string
134
- - name: gists_url
135
- dtype: string
136
- - name: gravatar_id
137
- dtype: string
138
- - name: html_url
139
- dtype: string
140
- - name: id
141
- dtype: int64
142
- - name: login
143
- dtype: string
144
- - name: node_id
145
- dtype: string
146
- - name: organizations_url
147
- dtype: string
148
- - name: received_events_url
149
- dtype: string
150
- - name: repos_url
151
- dtype: string
152
- - name: site_admin
153
- dtype: bool
154
- - name: starred_url
155
- dtype: string
156
- - name: subscriptions_url
157
- dtype: string
158
- - name: type
159
- dtype: string
160
- - name: url
161
- dtype: string
162
- - name: user_view_type
163
- dtype: string
164
- - name: milestone
165
- struct:
166
- - name: closed_at
167
- dtype: string
168
- - name: closed_issues
169
- dtype: int64
170
- - name: created_at
171
- dtype: string
172
- - name: creator
173
- struct:
174
- - name: avatar_url
175
- dtype: string
176
- - name: events_url
177
- dtype: string
178
- - name: followers_url
179
- dtype: string
180
- - name: following_url
181
- dtype: string
182
- - name: gists_url
183
- dtype: string
184
- - name: gravatar_id
185
- dtype: string
186
- - name: html_url
187
- dtype: string
188
- - name: id
189
- dtype: int64
190
- - name: login
191
- dtype: string
192
- - name: node_id
193
- dtype: string
194
- - name: organizations_url
195
- dtype: string
196
- - name: received_events_url
197
- dtype: string
198
- - name: repos_url
199
- dtype: string
200
- - name: site_admin
201
- dtype: bool
202
- - name: starred_url
203
- dtype: string
204
- - name: subscriptions_url
205
- dtype: string
206
- - name: type
207
- dtype: string
208
- - name: url
209
- dtype: string
210
- - name: user_view_type
211
- dtype: string
212
- - name: description
213
- dtype: string
214
- - name: due_on
215
- dtype: string
216
- - name: html_url
217
- dtype: string
218
- - name: id
219
- dtype: int64
220
- - name: labels_url
221
- dtype: string
222
- - name: node_id
223
- dtype: string
224
- - name: number
225
- dtype: int64
226
- - name: open_issues
227
- dtype: int64
228
- - name: state
229
- dtype: string
230
- - name: title
231
- dtype: string
232
- - name: updated_at
233
- dtype: string
234
- - name: url
235
- dtype: string
236
- - name: comments
237
- dtype: int64
238
- - name: created_at
239
- dtype: string
240
- - name: updated_at
241
- dtype: string
242
- - name: closed_at
243
- dtype: string
244
- - name: author_association
245
- dtype: string
246
- - name: type
247
- dtype: float64
248
- - name: active_lock_reason
249
- dtype: float64
250
- - name: draft
251
- dtype: float64
252
- - name: pull_request
253
- struct:
254
- - name: diff_url
255
- dtype: string
256
- - name: html_url
257
- dtype: string
258
- - name: merged_at
259
- dtype: string
260
- - name: patch_url
261
- dtype: string
262
- - name: url
263
- dtype: string
264
- - name: body
265
- dtype: string
266
- - name: closed_by
267
- struct:
268
- - name: avatar_url
269
- dtype: string
270
- - name: events_url
271
- dtype: string
272
- - name: followers_url
273
- dtype: string
274
- - name: following_url
275
- dtype: string
276
- - name: gists_url
277
- dtype: string
278
- - name: gravatar_id
279
- dtype: string
280
- - name: html_url
281
- dtype: string
282
- - name: id
283
- dtype: int64
284
- - name: login
285
- dtype: string
286
- - name: node_id
287
- dtype: string
288
- - name: organizations_url
289
- dtype: string
290
- - name: received_events_url
291
- dtype: string
292
- - name: repos_url
293
- dtype: string
294
- - name: site_admin
295
- dtype: bool
296
- - name: starred_url
297
- dtype: string
298
- - name: subscriptions_url
299
- dtype: string
300
- - name: type
301
- dtype: string
302
- - name: url
303
- dtype: string
304
- - name: user_view_type
305
- dtype: string
306
- - name: reactions
307
- struct:
308
- - name: '+1'
309
- dtype: int64
310
- - name: '-1'
311
- dtype: int64
312
- - name: confused
313
- dtype: int64
314
- - name: eyes
315
- dtype: int64
316
- - name: heart
317
- dtype: int64
318
- - name: hooray
319
- dtype: int64
320
- - name: laugh
321
- dtype: int64
322
- - name: rocket
323
- dtype: int64
324
- - name: total_count
325
- dtype: int64
326
- - name: url
327
- dtype: string
328
- - name: timeline_url
329
- dtype: string
330
- - name: performed_via_github_app
331
- dtype: float64
332
- - name: state_reason
333
- dtype: string
334
- - name: sub_issues_summary
335
- struct:
336
- - name: completed
337
- dtype: int64
338
- - name: percent_completed
339
- dtype: int64
340
- - name: total
341
- dtype: int64
342
- - name: issue_dependencies_summary
343
- struct:
344
- - name: blocked_by
345
- dtype: int64
346
- - name: blocking
347
- dtype: int64
348
- - name: total_blocked_by
349
- dtype: int64
350
- - name: total_blocking
351
- dtype: int64
352
- - name: is_pull_request
353
- dtype: bool
354
- splits:
355
- - name: train
356
- num_bytes: 30007928
357
- num_examples: 7744
358
- download_size: 5833903
359
- dataset_size: 30007928
360
- configs:
361
- - config_name: default
362
- data_files:
363
- - split: train
364
- path: data/train-*
365
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ TODO: "Add YAML tags here. Delete these instructions and copy-paste the YAML tags obtained with the online tagging app: https://huggingface.co/spaces/huggingface/datasets-tagging"
3
+ YAML tags: "Find the full spec here: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
+
6
+ # GitHub Issues without Comments
7
+
8
+ ## Table of Contents
9
+ - [Dataset Card Creation Guide](#dataset-card-creation-guide)
10
+ - [Table of Contents](#table-of-contents)
11
+ - [Dataset Description](#dataset-description)
12
+ - [Dataset Summary](#dataset-summary)
13
+ - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
14
+ - [Languages](#languages)
15
+ - [Dataset Structure](#dataset-structure)
16
+ - [Data Instances](#data-instances)
17
+ - [Data Fields](#data-fields)
18
+ - [Data Splits](#data-splits)
19
+ - [Dataset Creation](#dataset-creation)
20
+ - [Curation Rationale](#curation-rationale)
21
+ - [Source Data](#source-data)
22
+ - [Initial Data Collection and Normalization](#initial-data-collection-and-normalization)
23
+ - [Who are the source language producers?](#who-are-the-source-language-producers)
24
+ - [Annotations](#annotations)
25
+ - [Annotation process](#annotation-process)
26
+ - [Who are the annotators?](#who-are-the-annotators)
27
+ - [Personal and Sensitive Information](#personal-and-sensitive-information)
28
+ - [Considerations for Using the Data](#considerations-for-using-the-data)
29
+ - [Social Impact of Dataset](#social-impact-of-dataset)
30
+ - [Discussion of Biases](#discussion-of-biases)
31
+ - [Other Known Limitations](#other-known-limitations)
32
+ - [Additional Information](#additional-information)
33
+ - [Dataset Curators](#dataset-curators)
34
+ - [Licensing Information](#licensing-information)
35
+ - [Citation Information](#citation-information)
36
+ - [Contributions](#contributions)
37
+
38
+ ## Dataset Description
39
+
40
+ - **Homepage:** [Add homepage URL here if available (unless it's a GitHub repository)]()
41
+ - **Repository:** [If the dataset is hosted on github or has a github homepage, add URL here]()
42
+ - **Point of Contact:** [Liang Jinbin, liangjinbin93@gmail.com or 202511095245@scut.edu.cn]()
43
+
44
+ ### Dataset Summary
45
+
46
+ Briefly summarize the dataset, its intended use and the supported tasks. Give an overview of how and why the dataset was created. The summary should explicitly mention the languages present in the dataset (possibly in broad terms, e.g. *translations between several pairs of European languages*), and describe the domain, topic, or genre covered.
47
+
48
+ ### Supported Tasks and Leaderboards
49
+
50
+ For each of the tasks tagged for this dataset, give a brief description of the tag, metrics, and suggested models (with a link to their HuggingFace implementation if available). Give a similar description of tasks that were not covered by the structured tag set (repace the `task-category-tag` with an appropriate `other:other-task-name`).
51
+
52
+ - `task-category-tag`: The dataset can be used to train a model for [TASK NAME], which consists in [TASK DESCRIPTION]. Success on this task is typically measured by achieving a *high/low* [metric name](https://huggingface.co/metrics/metric_name). The ([model name](https://huggingface.co/model_name) or [model class](https://huggingface.co/transformers/model_doc/model_class.html)) model currently achieves the following score. *[IF A LEADERBOARD IS AVAILABLE]:* This task has an active leaderboard which can be found at [leaderboard url]() and ranks models based on [metric name](https://huggingface.co/metrics/metric_name) while also reporting [other metric name](https://huggingface.co/metrics/other_metric_name).
53
+
54
+ ### Languages
55
+
56
+ Provide a brief overview of the languages represented in the dataset. Describe relevant details about specifics of the language such as whether it is social media text, African American English,...
57
+
58
+ When relevant, please provide [BCP-47 codes](https://tools.ietf.org/html/bcp47), which consist of a [primary language subtag](https://tools.ietf.org/html/bcp47#section-2.2.1), with a [script subtag](https://tools.ietf.org/html/bcp47#section-2.2.3) and/or [region subtag](https://tools.ietf.org/html/bcp47#section-2.2.4) if available.
59
+
60
+ ## Dataset Structure
61
+
62
+ ### Data Instances
63
+
64
+ Provide an JSON-formatted example and brief description of a typical instance in the dataset. If available, provide a link to further examples.
65
+
66
+ ```
67
+ {
68
+ 'example_field': ...,
69
+ ...
70
+ }
71
+ ```
72
+
73
+ Provide any additional information that is not covered in the other sections about the data here. In particular describe any relationships between data points and if these relationships are made explicit.
74
+
75
+ ### Data Fields
76
+
77
+ List and describe the fields present in the dataset. Mention their data type, and whether they are used as input or output in any of the tasks the dataset currently supports. If the data has span indices, describe their attributes, such as whether they are at the character level or word level, whether they are contiguous or not, etc. If the datasets contains example IDs, state whether they have an inherent meaning, such as a mapping to other datasets or pointing to relationships between data points.
78
+
79
+ - `example_field`: description of `example_field`
80
+
81
+ Note that the descriptions can be initialized with the **Show Markdown Data Fields** output of the [Datasets Tagging app](https://huggingface.co/spaces/huggingface/datasets-tagging), you will then only need to refine the generated descriptions.
82
+
83
+ ### Data Splits
84
+
85
+ Describe and name the splits in the dataset if there are more than one.
86
+
87
+ Describe any criteria for splitting the data, if used. If there are differences between the splits (e.g. if the training annotations are machine-generated and the dev and test ones are created by humans, or if different numbers of annotators contributed to each example), describe them here.
88
+
89
+ Provide the sizes of each split. As appropriate, provide any descriptive statistics for the features, such as average length. For example:
90
+
91
+ | | train | validation | test |
92
+ |-------------------------|------:|-----------:|-----:|
93
+ | Input Sentences | | | |
94
+ | Average Sentence Length | | | |
95
+
96
+ ## Dataset Creation
97
+
98
+ ### Curation Rationale
99
+
100
+ What need motivated the creation of this dataset? What are some of the reasons underlying the major choices involved in putting it together?
101
+
102
+ ### Source Data
103
+
104
+ This section describes the source data (e.g. news text and headlines, social media posts, translated sentences,...)
105
+
106
+ #### Initial Data Collection and Normalization
107
+
108
+ Describe the data collection process. Describe any criteria for data selection or filtering. List any key words or search terms used. If possible, include runtime information for the collection process.
109
+
110
+ If data was collected from other pre-existing datasets, link to source here and to their [Hugging Face version](https://huggingface.co/datasets/dataset_name).
111
+
112
+ If the data was modified or normalized after being collected (e.g. if the data is word-tokenized), describe the process and the tools used.
113
+
114
+ #### Who are the source language producers?
115
+
116
+ State whether the data was produced by humans or machine generated. Describe the people or systems who originally created the data.
117
+
118
+ If available, include self-reported demographic or identity information for the source data creators, but avoid inferring this information. Instead state that this information is unknown. See [Larson 2017](https://www.aclweb.org/anthology/W17-1601.pdf) for using identity categories as a variables, particularly gender.
119
+
120
+ Describe the conditions under which the data was created (for example, if the producers were crowdworkers, state what platform was used, or if the data was found, what website the data was found on). If compensation was provided, include that information here.
121
+
122
+ Describe other people represented or mentioned in the data. Where possible, link to references for the information.
123
+
124
+ ### Annotations
125
+
126
+ If the dataset contains annotations which are not part of the initial data collection, describe them in the following paragraphs.
127
+
128
+ #### Annotation process
129
+
130
+ If applicable, describe the annotation process and any tools used, or state otherwise. Describe the amount of data annotated, if not all. Describe or reference annotation guidelines provided to the annotators. If available, provide interannotator statistics. Describe any annotation validation processes.
131
+
132
+ #### Who are the annotators?
133
+
134
+ If annotations were collected for the source data (such as class labels or syntactic parses), state whether the annotations were produced by humans or machine generated.
135
+
136
+ Describe the people or systems who originally created the annotations and their selection criteria if applicable.
137
+
138
+ If available, include self-reported demographic or identity information for the annotators, but avoid inferring this information. Instead state that this information is unknown. See [Larson 2017](https://www.aclweb.org/anthology/W17-1601.pdf) for using identity categories as a variables, particularly gender.
139
+
140
+ Describe the conditions under which the data was annotated (for example, if the annotators were crowdworkers, state what platform was used, or if the data was found, what website the data was found on). If compensation was provided, include that information here.
141
+
142
+ ### Personal and Sensitive Information
143
+
144
+ State whether the dataset uses identity categories and, if so, how the information is used. Describe where this information comes from (i.e. self-reporting, collecting from profiles, inferring, etc.). See [Larson 2017](https://www.aclweb.org/anthology/W17-1601.pdf) for using identity categories as a variables, particularly gender. State whether the data is linked to individuals and whether those individuals can be identified in the dataset, either directly or indirectly (i.e., in combination with other data).
145
+
146
+ State whether the dataset contains other data that might be considered sensitive (e.g., data that reveals racial or ethnic origins, sexual orientations, religious beliefs, political opinions or union memberships, or locations; financial or health data; biometric or genetic data; forms of government identification, such as social security numbers; criminal history).
147
+
148
+ If efforts were made to anonymize the data, describe the anonymization process.
149
+
150
+ ## Considerations for Using the Data
151
+
152
+ ### Social Impact of Dataset
153
+
154
+ Please discuss some of the ways you believe the use of this dataset will impact society.
155
+
156
+ The statement should include both positive outlooks, such as outlining how technologies developed through its use may improve people's lives, and discuss the accompanying risks. These risks may range from making important decisions more opaque to people who are affected by the technology, to reinforcing existing harmful biases (whose specifics should be discussed in the next section), among other considerations.
157
+
158
+ Also describe in this section if the proposed dataset contains a low-resource or under-represented language. If this is the case or if this task has any impact on underserved communities, please elaborate here.
159
+
160
+ ### Discussion of Biases
161
+
162
+ Provide descriptions of specific biases that are likely to be reflected in the data, and state whether any steps were taken to reduce their impact.
163
+
164
+ For Wikipedia text, see for example [Dinan et al 2020 on biases in Wikipedia (esp. Table 1)](https://arxiv.org/abs/2005.00614), or [Blodgett et al 2020](https://www.aclweb.org/anthology/2020.acl-main.485/) for a more general discussion of the topic.
165
+
166
+ If analyses have been run quantifying these biases, please add brief summaries and links to the studies here.
167
+
168
+ ### Other Known Limitations
169
+
170
+ If studies of the datasets have outlined other limitations of the dataset, such as annotation artifacts, please outline and cite them here.
171
+
172
+ ## Additional Information
173
+
174
+ ### Dataset Curators
175
+
176
+ List the people involved in collecting the dataset and their affiliation(s). If funding information is known, include it here.
177
+
178
+ ### Licensing Information
179
+
180
+ Provide the license and link to the license webpage if available.
181
+
182
+ ### Citation Information
183
+
184
+ Provide the [BibTex](http://www.bibtex.org/)-formatted reference for the dataset. For example:
185
+ ```
186
+ @article{article_id,
187
+ author = {Author List},
188
+ title = {Dataset Paper Title},
189
+ journal = {Publication Venue},
190
+ year = {2525}
191
+ }
192
+ ```
193
+
194
+ If the dataset has a [DOI](https://www.doi.org/), please provide it here.
195
+
196
+ ### Contributions
197
+
198
+ Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.