forked from huggingface/datasets
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_metadata_util.py
265 lines (230 loc) · 8.13 KB
/
test_metadata_util.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
import re
import tempfile
import unittest
from pathlib import Path
from datasets.utils.metadata import (
DatasetMetadata,
escape_validation_for_predicate,
metadata_dict_from_readme,
tagset_validator,
validate_metadata_type,
yaml_block_from_readme,
)
def _dedent(string: str) -> str:
indent_level = min(re.search("^ +", t).end() if t.startswith(" ") else 0 for t in string.splitlines())
return "\n".join([line[indent_level:] for line in string.splitlines()])
README_YAML = """\
---
languages:
- zh
- en
task_ids:
- sentiment-classification
---
# Begin of markdown
Some cool dataset card
"""
README_EMPTY_YAML = """\
---
---
# Begin of markdown
Some cool dataset card
"""
README_NO_YAML = """\
# Begin of markdown
Some cool dataset card
"""
class TestMetadataUtils(unittest.TestCase):
def test_validate_metadata_type(self):
metadata_dict = {
"tag": ["list", "of", "values"],
"another tag": ["Another", {"list"}, ["of"], 0x646D46736457567A],
}
validate_metadata_type(metadata_dict)
metadata_dict = {"tag1": []}
with self.assertRaises(TypeError):
validate_metadata_type(metadata_dict)
metadata_dict = {"tag1": None}
with self.assertRaises(TypeError):
validate_metadata_type(metadata_dict)
def test_tagset_validator(self):
name = "test_tag"
url = "https://dummy.hf.co"
values = ["tag1", "tag2", "tag2", "tag3"]
reference_values = ["tag1", "tag2", "tag3"]
returned_values, error = tagset_validator(values=values, reference_values=reference_values, name=name, url=url)
self.assertListEqual(returned_values, values)
self.assertIsNone(error)
values = []
reference_values = ["tag1", "tag2", "tag3"]
returned_values, error = tagset_validator(values=values, reference_values=reference_values, name=name, url=url)
self.assertListEqual(returned_values, values)
self.assertIsNone(error)
values = []
reference_values = []
returned_values, error = tagset_validator(values=values, reference_values=reference_values, name=name, url=url)
self.assertListEqual(returned_values, values)
self.assertIsNone(error)
values = ["tag1", "tag2", "tag2", "tag3", "unknown tag"]
reference_values = ["tag1", "tag2", "tag3"]
returned_values, error = tagset_validator(values=values, reference_values=reference_values, name=name, url=url)
self.assertListEqual(returned_values, [])
self.assertEqual(error, f"{['unknown tag']} are not registered tags for '{name}', reference at {url}")
def test_escape_validation_for_predicate(self):
def predicate_fn(string: str) -> bool:
return "ignore" in string
values = ["process me", "process me too", "ignore me"]
to_ignore, to_validate = escape_validation_for_predicate(values=values, predicate_fn=predicate_fn)
self.assertListEqual(to_ignore, ["ignore me"])
self.assertListEqual(to_validate, ["process me", "process me too"])
values = ["process me", "process me too"]
to_ignore, to_validate = escape_validation_for_predicate(values=values, predicate_fn=predicate_fn)
self.assertListEqual(to_ignore, [])
self.assertListEqual(to_validate, values)
values = ["this value will be ignored", "ignore this one two"]
to_ignore, to_validate = escape_validation_for_predicate(values=values, predicate_fn=predicate_fn)
self.assertListEqual(to_ignore, values)
self.assertListEqual(to_validate, [])
def test_yaml_block_from_readme(self):
with tempfile.TemporaryDirectory() as tmp_dir:
path = Path(tmp_dir) / "README.md"
with open(path, "w+") as readme_file:
readme_file.write(README_YAML)
yaml_block = yaml_block_from_readme(path=path)
self.assertEqual(
yaml_block,
_dedent(
"""\
languages:
- zh
- en
task_ids:
- sentiment-classification
"""
),
)
with open(path, "w+") as readme_file:
readme_file.write(README_EMPTY_YAML)
yaml_block = yaml_block_from_readme(path=path)
self.assertEqual(
yaml_block,
_dedent(
"""\
"""
),
)
with open(path, "w+") as readme_file:
readme_file.write(README_NO_YAML)
yaml_block = yaml_block_from_readme(path=path)
self.assertIsNone(yaml_block)
def test_metadata_dict_from_readme(self):
with tempfile.TemporaryDirectory() as tmp_dir:
path = Path(tmp_dir) / "README.md"
with open(path, "w+") as readme_file:
readme_file.write(README_YAML)
metadata_dict = metadata_dict_from_readme(path)
self.assertDictEqual(metadata_dict, {"languages": ["zh", "en"], "task_ids": ["sentiment-classification"]})
with open(path, "w+") as readme_file:
readme_file.write(README_EMPTY_YAML)
metadata_dict = metadata_dict_from_readme(path)
self.assertDictEqual(metadata_dict, {})
with open(path, "w+") as readme_file:
readme_file.write(README_NO_YAML)
metadata_dict = metadata_dict_from_readme(path)
self.assertIsNone(metadata_dict)
def test_from_yaml_string(self):
valid_yaml_string = _dedent(
"""\
annotations_creators:
- found
language_creators:
- found
languages:
- en
licenses:
- unknown
multilinguality:
- monolingual
size_categories:
- 10K<n<100K
source_datasets:
- extended|other-yahoo-webscope-l6
task_categories:
- question-answering
task_ids:
- open-domain-qa
"""
)
DatasetMetadata.from_yaml_string(valid_yaml_string)
valid_yaml_string_with_configs = _dedent(
"""\
annotations_creators:
- found
language_creators:
- found
languages:
en:
- en
fr:
- fr
licenses:
- unknown
multilinguality:
- monolingual
size_categories:
- 10K<n<100K
source_datasets:
- extended|other-yahoo-webscope-l6
task_categories:
- question-answering
task_ids:
- open-domain-qa
"""
)
DatasetMetadata.from_yaml_string(valid_yaml_string_with_configs)
invalid_tag_yaml = _dedent(
"""\
annotations_creators:
- found
language_creators:
- some guys in Panama
languages:
- en
licenses:
- unknown
multilinguality:
- monolingual
size_categories:
- 10K<n<100K
source_datasets:
- extended|other-yahoo-webscope-l6
task_categories:
- question-answering
task_ids:
- open-domain-qa
"""
)
with self.assertRaises(TypeError):
DatasetMetadata.from_yaml_string(invalid_tag_yaml)
missing_tag_yaml = _dedent(
"""\
annotations_creators:
- found
languages:
- en
licenses:
- unknown
multilinguality:
- monolingual
size_categories:
- 10K<n<100K
source_datasets:
- extended|other-yahoo-webscope-l6
task_categories:
- question-answering
task_ids:
- open-domain-qa
"""
)
with self.assertRaises(TypeError):
DatasetMetadata.from_yaml_string(missing_tag_yaml)