datalab2 commited on
Commit
66ae049
·
verified ·
1 Parent(s): 73c3a48

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -41
README.md CHANGED
@@ -22,123 +22,123 @@ This dataset card aims to be a base template for new datasets. It has been gener
22
  - **Curated by:** [Will be diisclosed later]
23
  - **Funded by [optional]:** [Will be diisclosed later]
24
  - **Shared by [optional]:** [Will be diisclosed later]
 
25
  - **Language(s) (NLP):** [More Information Needed]
26
  - **License:** [More Information Needed]
27
 
28
- ### Dataset Sources [optional]
29
 
30
  <!-- Provide the basic links for the dataset. -->
31
 
32
- - **Repository:** [More Information Needed]
33
  - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
- ## Uses
37
 
38
  <!-- Address questions around how the dataset is intended to be used. -->
39
 
40
- ### Direct Use
41
 
42
  <!-- This section describes suitable use cases for the dataset. -->
43
 
44
- [More Information Needed]
45
 
46
- ### Out-of-Scope Use
47
 
48
  <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
49
 
50
- [More Information Needed]
51
 
52
- ## Dataset Structure
53
 
54
  <!-- 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. -->
55
 
56
- [More Information Needed]
57
 
58
- ## Dataset Creation
59
 
60
- ### Curation Rationale
61
 
62
  <!-- Motivation for the creation of this dataset. -->
63
 
64
- [More Information Needed]
65
 
66
- ### Source Data
67
 
68
  <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
69
 
70
- #### Data Collection and Processing
71
 
72
  <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
73
 
74
- [More Information Needed]
75
 
76
- #### Who are the source data producers?
77
 
78
  <!-- 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. -->
79
 
80
- [More Information Needed]
81
 
82
- ### Annotations [optional]
83
 
84
  <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
85
 
86
- #### Annotation process
87
 
88
  <!-- 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. -->
89
 
90
- [More Information Needed]
91
 
92
- #### Who are the annotators?
93
 
94
  <!-- This section describes the people or systems who created the annotations. -->
95
 
96
- [More Information Needed]
97
 
98
- #### Personal and Sensitive Information
99
 
100
  <!-- 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. -->
101
 
102
- [More Information Needed]
103
 
104
- ## Bias, Risks, and Limitations
105
 
106
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
107
 
108
- [More Information Needed]
109
 
110
- ### Recommendations
111
 
112
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
113
 
114
- Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
115
 
116
- ## Citation [optional]
117
 
118
  <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
119
 
120
- **BibTeX:**
121
 
122
- [More Information Needed]
123
 
124
- **APA:**
125
 
126
- [More Information Needed]
127
 
128
- ## Glossary [optional]
129
 
130
  <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
131
 
132
- [More Information Needed]
133
 
134
- ## More Information [optional]
135
 
136
- [More Information Needed]
137
 
138
- ## Dataset Card Authors [optional]
139
 
140
  [More Information Needed]
141
 
142
  ## Dataset Card Contact
143
-
144
- [More Information Needed]
 
22
  - **Curated by:** [Will be diisclosed later]
23
  - **Funded by [optional]:** [Will be diisclosed later]
24
  - **Shared by [optional]:** [Will be diisclosed later]
25
+ <!--
26
  - **Language(s) (NLP):** [More Information Needed]
27
  - **License:** [More Information Needed]
28
 
29
+ ### Dataset Sources [optional] -->
30
 
31
  <!-- Provide the basic links for the dataset. -->
32
 
33
+ <!-- - **Repository:** [More Information Needed]
34
  - **Paper [optional]:** [More Information Needed]
35
+ - **Demo [optional]:** [More Information Needed] -->
36
 
37
+ <!-- ## Uses -->
38
 
39
  <!-- Address questions around how the dataset is intended to be used. -->
40
 
41
+ <!-- ### Direct Use -->
42
 
43
  <!-- This section describes suitable use cases for the dataset. -->
44
 
45
+ <!-- [More Information Needed] -->
46
 
47
+ <!-- ### Out-of-Scope Use -->
48
 
49
  <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
50
 
51
+ <!-- [More Information Needed] -->
52
 
53
+ <!-- ## Dataset Structure -->
54
 
55
  <!-- 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. -->
56
 
57
+ <!-- [More Information Needed] -->
58
 
59
+ <!-- ## Dataset Creation -->
60
 
61
+ <!-- ### Curation Rationale -->
62
 
63
  <!-- Motivation for the creation of this dataset. -->
64
 
65
+ <!-- [More Information Needed] -->
66
 
67
+ <!-- ### Source Data -->
68
 
69
  <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
70
 
71
+ <!-- #### Data Collection and Processing -->
72
 
73
  <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
74
 
75
+ <!-- [More Information Needed] -->
76
 
77
+ <!-- #### Who are the source data producers? -->
78
 
79
  <!-- 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. -->
80
 
81
+ <!-- [More Information Needed] -->
82
 
83
+ <!-- ### Annotations [optional] -->
84
 
85
  <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
86
 
87
+ <!-- #### Annotation process -->
88
 
89
  <!-- 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. -->
90
 
91
+ <!-- [More Information Needed] -->
92
 
93
+ <!-- #### Who are the annotators? -->
94
 
95
  <!-- This section describes the people or systems who created the annotations. -->
96
 
97
+ <!-- [More Information Needed] -->
98
 
99
+ <!-- #### Personal and Sensitive Information -->
100
 
101
  <!-- 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. -->
102
 
103
+ <!-- [More Information Needed] -->
104
 
105
+ <!-- ## Bias, Risks, and Limitations -->
106
 
107
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
108
 
109
+ <!-- [More Information Needed] -->
110
 
111
+ <!-- ### Recommendations -->
112
 
113
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
114
 
115
+ <!-- Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations. -->
116
 
117
+ <!-- ## Citation [optional] -->
118
 
119
  <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
120
 
121
+ <!-- **BibTeX:** -->
122
 
123
+ <!-- [More Information Needed] -->
124
 
125
+ <!-- **APA:** -->
126
 
127
+ <!-- [More Information Needed] -->
128
 
129
+ <!-- ## Glossary [optional] -->
130
 
131
  <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
132
 
133
+ <!-- [More Information Needed] -->
134
 
135
+ <!-- ## More Information [optional] -->
136
 
137
+ <!-- [More Information Needed] -->
138
 
139
+ <!-- ## Dataset Card Authors [optional]
140
 
141
  [More Information Needed]
142
 
143
  ## Dataset Card Contact
144
+ -->