Taylor658 commited on
Commit
bf9e259
1 Parent(s): b3fef72

Update README.md

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