davanstrien HF staff commited on
Commit
c9a611a
1 Parent(s): cb95fff

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -90
README.md CHANGED
@@ -54,155 +54,69 @@ task_ids: []
54
 
55
  ### Dataset Summary
56
 
57
- 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.
58
 
59
  ### Supported Tasks and Leaderboards
60
 
61
- 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`).
62
 
63
- - `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).
64
 
65
  ### Languages
66
 
67
- 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,...
68
-
69
- 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.
70
-
71
  ## Dataset Structure
72
 
73
  ### Data Instances
74
 
75
- Provide an JSON-formatted example and brief description of a typical instance in the dataset. If available, provide a link to further examples.
76
-
77
- ```
78
- {
79
- 'example_field': ...,
80
- ...
81
- }
82
- ```
83
-
84
- 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.
85
-
86
  ### Data Fields
87
 
88
- 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.
89
-
90
- - `example_field`: description of `example_field`
91
-
92
- 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.
93
 
94
  ### Data Splits
95
 
96
- Describe and name the splits in the dataset if there are more than one.
97
-
98
- 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.
99
-
100
- Provide the sizes of each split. As appropriate, provide any descriptive statistics for the features, such as average length. For example:
101
-
102
- | | train | validation | test |
103
- |-------------------------|------:|-----------:|-----:|
104
- | Input Sentences | | | |
105
- | Average Sentence Length | | | |
106
-
107
  ## Dataset Creation
108
 
109
  ### Curation Rationale
110
 
111
- What need motivated the creation of this dataset? What are some of the reasons underlying the major choices involved in putting it together?
112
-
113
- ### Source Data
114
 
115
- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences,...)
116
 
117
- #### Initial Data Collection and Normalization
118
 
119
- 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.
120
 
121
- 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).
122
 
123
- 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.
124
 
125
  #### Who are the source language producers?
126
 
127
- State whether the data was produced by humans or machine generated. Describe the people or systems who originally created the data.
128
-
129
- 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.
130
-
131
- 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.
132
-
133
- Describe other people represented or mentioned in the data. Where possible, link to references for the information.
134
 
135
  ### Annotations
136
 
137
- If the dataset contains annotations which are not part of the initial data collection, describe them in the following paragraphs.
138
 
139
  #### Annotation process
140
 
141
- 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.
142
 
143
  #### Who are the annotators?
144
 
145
- 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.
146
-
147
- Describe the people or systems who originally created the annotations and their selection criteria if applicable.
148
-
149
- 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.
150
-
151
- 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.
152
-
153
  ### Personal and Sensitive Information
154
 
155
- 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).
156
-
157
- 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).
158
-
159
- If efforts were made to anonymize the data, describe the anonymization process.
160
 
161
  ## Considerations for Using the Data
162
 
163
  ### Social Impact of Dataset
164
 
165
- Please discuss some of the ways you believe the use of this dataset will impact society.
166
-
167
- 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.
168
-
169
- 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.
170
 
171
  ### Discussion of Biases
172
 
173
- 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.
174
-
175
- 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.
176
-
177
- If analyses have been run quantifying these biases, please add brief summaries and links to the studies here.
178
-
179
  ### Other Known Limitations
180
 
181
- If studies of the datasets have outlined other limitations of the dataset, such as annotation artifacts, please outline and cite them here.
182
 
183
  ## Additional Information
184
 
185
  ### Dataset Curators
186
 
187
- List the people involved in collecting the dataset and their affiliation(s). If funding information is known, include it here.
188
 
189
  ### Licensing Information
190
 
191
- Provide the license and link to the license webpage if available.
192
-
193
  ### Citation Information
194
 
195
- Provide the [BibTex](http://www.bibtex.org/)-formatted reference for the dataset. For example:
196
- ```
197
- @article{article_id,
198
- author = {Author List},
199
- title = {Dataset Paper Title},
200
- journal = {Publication Venue},
201
- year = {2525}
202
- }
203
- ```
204
-
205
- If the dataset has a [DOI](https://www.doi.org/), please provide it here.
206
 
207
  ### Contributions
208
 
 
54
 
55
  ### Dataset Summary
56
 
 
57
 
58
  ### Supported Tasks and Leaderboards
59
 
 
60
 
 
61
 
62
  ### Languages
63
 
 
 
 
 
64
  ## Dataset Structure
65
 
66
  ### Data Instances
67
 
 
 
 
 
 
 
 
 
 
 
 
68
  ### Data Fields
69
 
 
 
 
 
 
70
 
71
  ### Data Splits
72
 
 
 
 
 
 
 
 
 
 
 
 
73
  ## Dataset Creation
74
 
75
  ### Curation Rationale
76
 
 
 
 
77
 
 
78
 
79
+ ### Source Data
80
 
 
81
 
 
82
 
83
+ #### Initial Data Collection and Normalization
84
 
85
  #### Who are the source language producers?
86
 
 
 
 
 
 
 
 
87
 
88
  ### Annotations
89
 
90
+
91
 
92
  #### Annotation process
93
 
 
94
 
95
  #### Who are the annotators?
96
 
 
 
 
 
 
 
 
 
97
  ### Personal and Sensitive Information
98
 
 
 
 
 
 
99
 
100
  ## Considerations for Using the Data
101
 
102
  ### Social Impact of Dataset
103
 
 
 
 
 
 
104
 
105
  ### Discussion of Biases
106
 
 
 
 
 
 
 
107
  ### Other Known Limitations
108
 
109
+
110
 
111
  ## Additional Information
112
 
113
  ### Dataset Curators
114
 
 
115
 
116
  ### Licensing Information
117
 
 
 
118
  ### Citation Information
119
 
 
 
 
 
 
 
 
 
 
 
 
120
 
121
  ### Contributions
122