Taylor658 commited on
Commit
6367b09
1 Parent(s): ba020b4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +116 -52
README.md CHANGED
@@ -1,126 +1,190 @@
1
  ---
2
  license: mit
3
  ---
4
- Dataset Card
5
- Developed by: [More Information Needed]
6
- Shared by [optional]: [More Information Needed]
7
- Dataset type: [More Information Needed]
8
- Language(s) (NLP): [More Information Needed]
9
- License: [More Information Needed]
10
- Derived from dataset [optional]: [More Information Needed]
11
- Dataset Sources [optional]
 
 
 
 
 
 
 
 
12
  <!-- Provide the basic links for the dataset. -->
13
- Repository: [More Information Needed]
14
- Paper [optional]: [More Information Needed]
15
- Demo [optional]: [More Information Needed]
16
- Uses
 
 
 
 
 
17
  <!-- Address questions around how the dataset is intended to be used, including the foreseeable users of the dataset and those affected by the dataset. -->
18
- Direct Use
 
 
19
  <!-- This section is for the dataset use without modification or integration into a larger system. -->
 
20
  [More Information Needed]
21
 
22
- Downstream Use [optional]
 
23
  <!-- This section is for the dataset use when integrated or modified for a task, or when plugged into a larger ecosystem/app. -->
 
24
  [More Information Needed]
25
 
26
- Out-of-Scope Use
 
27
  <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
 
28
  [More Information Needed]
29
 
30
- Bias, Risks, and Limitations
 
31
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
32
  [More Information Needed]
33
 
34
- Recommendations
 
35
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
36
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
37
 
38
- How to Get Started with the Dataset
 
39
  Use the code below to get started with the dataset.
40
 
41
  [More Information Needed]
42
 
43
- Collection Details
44
- Source Data
 
 
45
  <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the source data is all about as well as documentation related to data pre-processing or additional filtering. -->
 
46
  [More Information Needed]
47
 
48
- Collection Procedures
 
49
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the collection procedure. -->
50
- Preprocessing [optional]
 
 
51
  [More Information Needed]
52
 
53
- Collection Hyperparameters
 
54
  Collection regime: [More Information Needed] <!-- Details about the data collection process -->
55
- Speeds, Sizes, Times [optional]
 
 
56
  <!-- This section provides information about data size, collection start/end time, etc. -->
 
57
  [More Information Needed]
58
 
59
- Evaluation
 
60
  <!-- This section describes the evaluation protocols and provides the results. -->
61
- Testing Data, Factors & Metrics
62
- Testing Data
 
 
 
63
  <!-- This should link to a Dataset Card if possible. -->
 
64
  [More Information Needed]
65
 
66
- Factors
 
67
  <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
68
  [More Information Needed]
69
 
70
- Metrics
 
71
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
72
  [More Information Needed]
73
 
74
- Results
 
75
  [More Information Needed]
76
 
77
- Summary
78
- Dataset Examination [optional]
 
 
79
  <!-- Relevant analysis work for the dataset goes here -->
 
80
  [More Information Needed]
81
 
82
- Environmental Impact
 
83
  <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
84
- Hardware Type: [More Information Needed]
85
- Hours used: [More Information Needed]
86
- Cloud Provider: [More Information Needed]
87
- Compute Region: [More Information Needed]
88
- Carbon Emitted: [More Information Needed]
89
- Technical Specifications [optional]
90
- Dataset Structure and Objective
 
 
 
 
 
 
 
 
91
  [More Information Needed]
92
 
93
- Compute Infrastructure
 
94
  [More Information Needed]
95
 
96
- Hardware
 
97
  [More Information Needed]
98
 
99
- Software
 
100
  [More Information Needed]
101
 
102
- Citation [optional]
 
103
  Dataset citation: https://doi.org/10.5281/zenodo.7242864
104
 
105
- BibTeX:
106
 
107
  [More Information Needed]
108
 
109
- APA:
110
 
111
  [More Information Needed]
112
 
113
- Glossary [optional]
 
114
  <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
115
- [More Information Needed]
116
 
117
- More Information [optional]
118
  [More Information Needed]
119
 
120
- Dataset Card Authors [optional]
 
121
  [More Information Needed]
122
 
123
- Dataset Card Contact
 
124
  [More Information Needed]
125
 
126
- This version aligns with the structure of a dataset card, focusing on the dataset's specifics, usage, collection, and technical details.
 
 
 
1
  ---
2
  license: mit
3
  ---
4
+ # Dataset Card
5
+
6
+ **Developed by:** [More Information Needed]
7
+
8
+ **Shared by [optional]:** [More Information Needed]
9
+
10
+ **Dataset type:** [More Information Needed]
11
+
12
+ **Language(s) (NLP):** [More Information Needed]
13
+
14
+ **License:** [More Information Needed]
15
+
16
+ **Derived from dataset [optional]:** [More Information Needed]
17
+
18
+ **Dataset Sources [optional]**
19
+
20
  <!-- Provide the basic links for the dataset. -->
21
+
22
+ **Repository:** [More Information Needed]
23
+
24
+ **Paper [optional]:** [More Information Needed]
25
+
26
+ **Demo [optional]:** [More Information Needed]
27
+
28
+ **Uses**
29
+
30
  <!-- Address questions around how the dataset is intended to be used, including the foreseeable users of the dataset and those affected by the dataset. -->
31
+
32
+ **Direct Use**
33
+
34
  <!-- This section is for the dataset use without modification or integration into a larger system. -->
35
+
36
  [More Information Needed]
37
 
38
+ **Downstream Use [optional]**
39
+
40
  <!-- This section is for the dataset use when integrated or modified for a task, or when plugged into a larger ecosystem/app. -->
41
+
42
  [More Information Needed]
43
 
44
+ **Out-of-Scope Use**
45
+
46
  <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
47
+
48
  [More Information Needed]
49
 
50
+ **Bias, Risks, and Limitations**
51
+
52
  <!-- This section is meant to convey both technical and sociotechnical limitations. -->
53
+
54
  [More Information Needed]
55
 
56
+ **Recommendations**
57
+
58
  <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
59
+
60
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
61
 
62
+ **How to Get Started with the Dataset**
63
+
64
  Use the code below to get started with the dataset.
65
 
66
  [More Information Needed]
67
 
68
+ **Collection Details**
69
+
70
+ **Source Data**
71
+
72
  <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the source data is all about as well as documentation related to data pre-processing or additional filtering. -->
73
+
74
  [More Information Needed]
75
 
76
+ **Collection Procedures**
77
+
78
  <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the collection procedure. -->
79
+
80
+ **Preprocessing [optional]**
81
+
82
  [More Information Needed]
83
 
84
+ **Collection Hyperparameters**
85
+
86
  Collection regime: [More Information Needed] <!-- Details about the data collection process -->
87
+
88
+ **Speeds, Sizes, Times [optional]**
89
+
90
  <!-- This section provides information about data size, collection start/end time, etc. -->
91
+
92
  [More Information Needed]
93
 
94
+ **Evaluation**
95
+
96
  <!-- This section describes the evaluation protocols and provides the results. -->
97
+
98
+ **Testing Data, Factors & Metrics**
99
+
100
+ **Testing Data**
101
+
102
  <!-- This should link to a Dataset Card if possible. -->
103
+
104
  [More Information Needed]
105
 
106
+ **Factors**
107
+
108
  <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
109
+
110
  [More Information Needed]
111
 
112
+ **Metrics**
113
+
114
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
115
+
116
  [More Information Needed]
117
 
118
+ **Results**
119
+
120
  [More Information Needed]
121
 
122
+ **Summary**
123
+
124
+ **Dataset Examination [optional]**
125
+
126
  <!-- Relevant analysis work for the dataset goes here -->
127
+
128
  [More Information Needed]
129
 
130
+ **Environmental Impact**
131
+
132
  <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
133
+
134
+ **Hardware Type:** [More Information Needed]
135
+
136
+ **Hours used:** [More Information Needed]
137
+
138
+ **Cloud Provider:** [More Information Needed]
139
+
140
+ **Compute Region:** [More Information Needed]
141
+
142
+ **Carbon Emitted:** [More Information Needed]
143
+
144
+ **Technical Specifications [optional]**
145
+
146
+ **Dataset Structure and Objective**
147
+
148
  [More Information Needed]
149
 
150
+ **Compute Infrastructure**
151
+
152
  [More Information Needed]
153
 
154
+ **Hardware**
155
+
156
  [More Information Needed]
157
 
158
+ **Software**
159
+
160
  [More Information Needed]
161
 
162
+ **Citation [optional]**
163
+
164
  Dataset citation: https://doi.org/10.5281/zenodo.7242864
165
 
166
+ **BibTeX:**
167
 
168
  [More Information Needed]
169
 
170
+ **APA:**
171
 
172
  [More Information Needed]
173
 
174
+ **Glossary [optional]**
175
+
176
  <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
 
177
 
 
178
  [More Information Needed]
179
 
180
+ **More Information [optional]**
181
+
182
  [More Information Needed]
183
 
184
+ **Dataset Card Authors [optional]**
185
+
186
  [More Information Needed]
187
 
188
+ **Dataset Card Contact**
189
+
190
+ [More Information Needed]