lllaurenceee commited on
Commit
2235ceb
·
verified ·
1 Parent(s): 47f3c11

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +60 -77
README.md CHANGED
@@ -1,56 +1,65 @@
1
  ---
2
- # For reference on dataset card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1
3
- # Doc / guide: https://huggingface.co/docs/hub/datasets-cards
4
- {}
5
  ---
6
 
7
- # Dataset Card for Dataset Name
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
 
9
- <!-- Provide a quick summary of the dataset. -->
10
-
11
- 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).
12
-
13
- ## Dataset Details
14
-
15
- ### Dataset Description
16
-
17
- <!-- Provide a longer summary of what this dataset is. -->
18
-
19
-
20
-
21
- - **Curated by:** [More Information Needed]
22
- - **Funded by [optional]:** [More Information Needed]
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
-
27
- ### Dataset Sources [optional]
28
 
29
- <!-- Provide the basic links for the dataset. -->
30
 
31
- - **Repository:** [More Information Needed]
32
- - **Paper [optional]:** [More Information Needed]
33
- - **Demo [optional]:** [More Information Needed]
34
 
35
- ## Uses
36
 
37
- <!-- Address questions around how the dataset is intended to be used. -->
38
 
39
- ### Direct Use
40
 
41
- <!-- This section describes suitable use cases for the dataset. -->
42
 
43
  [More Information Needed]
44
 
45
- ### Out-of-Scope Use
46
-
47
- <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
48
 
49
  [More Information Needed]
50
 
51
- ## Dataset Structure
52
-
53
- <!-- 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. -->
54
 
55
  [More Information Needed]
56
 
@@ -58,86 +67,60 @@ This dataset card aims to be a base template for new datasets. It has been gener
58
 
59
  ### Curation Rationale
60
 
61
- <!-- Motivation for the creation of this dataset. -->
62
-
63
  [More Information Needed]
64
 
65
  ### Source Data
66
 
67
- <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
68
-
69
- #### Data Collection and Processing
70
-
71
- <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
72
 
73
  [More Information Needed]
74
 
75
- #### Who are the source data producers?
76
-
77
- <!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
78
 
79
  [More Information Needed]
80
 
81
- ### Annotations [optional]
82
-
83
- <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
84
 
85
  #### Annotation process
86
 
87
- <!-- 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. -->
88
-
89
  [More Information Needed]
90
 
91
  #### Who are the annotators?
92
 
93
- <!-- This section describes the people or systems who created the annotations. -->
94
-
95
  [More Information Needed]
96
 
97
- #### Personal and Sensitive Information
98
-
99
- <!-- 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. -->
100
 
101
  [More Information Needed]
102
 
103
- ## Bias, Risks, and Limitations
104
 
105
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
106
 
107
  [More Information Needed]
108
 
109
- ### Recommendations
110
-
111
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
112
-
113
- Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
114
-
115
- ## Citation [optional]
116
-
117
- <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
118
-
119
- **BibTeX:**
120
 
121
  [More Information Needed]
122
 
123
- **APA:**
124
 
125
  [More Information Needed]
126
 
127
- ## Glossary [optional]
128
 
129
- <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
130
 
131
  [More Information Needed]
132
 
133
- ## More Information [optional]
134
 
135
  [More Information Needed]
136
 
137
- ## Dataset Card Authors [optional]
138
 
139
  [More Information Needed]
140
 
141
- ## Dataset Card Contact
142
 
143
- [More Information Needed]
 
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
  ---
4
 
5
+ # Dataset Card for [Dataset Name]
6
+
7
+ ## Table of Contents
8
+ - [Table of Contents](#table-of-contents)
9
+ - [Dataset Description](#dataset-description)
10
+ - [Dataset Summary](#dataset-summary)
11
+ - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
12
+ - [Languages](#languages)
13
+ - [Dataset Structure](#dataset-structure)
14
+ - [Data Instances](#data-instances)
15
+ - [Data Fields](#data-fields)
16
+ - [Data Splits](#data-splits)
17
+ - [Dataset Creation](#dataset-creation)
18
+ - [Curation Rationale](#curation-rationale)
19
+ - [Source Data](#source-data)
20
+ - [Annotations](#annotations)
21
+ - [Personal and Sensitive Information](#personal-and-sensitive-information)
22
+ - [Considerations for Using the Data](#considerations-for-using-the-data)
23
+ - [Social Impact of Dataset](#social-impact-of-dataset)
24
+ - [Discussion of Biases](#discussion-of-biases)
25
+ - [Other Known Limitations](#other-known-limitations)
26
+ - [Additional Information](#additional-information)
27
+ - [Dataset Curators](#dataset-curators)
28
+ - [Licensing Information](#licensing-information)
29
+ - [Citation Information](#citation-information)
30
+ - [Contributions](#contributions)
31
+
32
+ ## Dataset Description
33
+
34
+ - **Homepage:**
35
+ - **Repository:**
36
+ - **Paper:**
37
+ - **Leaderboard:**
38
+ - **Point of Contact:**
39
+
40
+ ### Dataset Summary
41
 
42
+ [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
43
 
44
+ ### Supported Tasks and Leaderboards
45
 
46
+ [More Information Needed]
 
 
47
 
48
+ ### Languages
49
 
50
+ [More Information Needed]
51
 
52
+ ## Dataset Structure
53
 
54
+ ### Data Instances
55
 
56
  [More Information Needed]
57
 
58
+ ### Data Fields
 
 
59
 
60
  [More Information Needed]
61
 
62
+ ### Data Splits
 
 
63
 
64
  [More Information Needed]
65
 
 
67
 
68
  ### Curation Rationale
69
 
 
 
70
  [More Information Needed]
71
 
72
  ### Source Data
73
 
74
+ #### Initial Data Collection and Normalization
 
 
 
 
75
 
76
  [More Information Needed]
77
 
78
+ #### Who are the source language producers?
 
 
79
 
80
  [More Information Needed]
81
 
82
+ ### Annotations
 
 
83
 
84
  #### Annotation process
85
 
 
 
86
  [More Information Needed]
87
 
88
  #### Who are the annotators?
89
 
 
 
90
  [More Information Needed]
91
 
92
+ ### Personal and Sensitive Information
 
 
93
 
94
  [More Information Needed]
95
 
96
+ ## Considerations for Using the Data
97
 
98
+ ### Social Impact of Dataset
99
 
100
  [More Information Needed]
101
 
102
+ ### Discussion of Biases
 
 
 
 
 
 
 
 
 
 
103
 
104
  [More Information Needed]
105
 
106
+ ### Other Known Limitations
107
 
108
  [More Information Needed]
109
 
110
+ ## Additional Information
111
 
112
+ ### Dataset Curators
113
 
114
  [More Information Needed]
115
 
116
+ ### Licensing Information
117
 
118
  [More Information Needed]
119
 
120
+ ### Citation Information
121
 
122
  [More Information Needed]
123
 
124
+ ### Contributions
125
 
126
+ Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.