-
Notifications
You must be signed in to change notification settings - Fork 39
/
base.py
397 lines (308 loc) · 11.5 KB
/
base.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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
import hashlib
import json
import types
import itertools
from typing import NamedTuple
import ir_datasets
_logger = ir_datasets.log.easy()
class GenericDoc(NamedTuple):
doc_id: str
text: str
def default_text(self):
return self.text
class GenericQuery(NamedTuple):
query_id: str
text: str
def default_text(self):
return self.text
class GenericQrel(NamedTuple):
query_id: str
doc_id: str
relevance: int
class GenericScoredDoc(NamedTuple):
query_id: str
doc_id: str
score: float
class GenericDocPair(NamedTuple):
query_id: str
doc_id_a: str
doc_id_b: str
class BaseDocs:
PREFIX = 'docs_'
EXTENSIONS = {}
def __getattr__(self, attr):
if attr.startswith(self.PREFIX) and attr in self.EXTENSIONS:
# Return method bound to this instance
return types.MethodType(self.EXTENSIONS[attr], self)
raise AttributeError(attr)
def docs_iter(self):
raise NotImplementedError()
def docs_count(self):
raise NotImplementedError()
def docs_handler(self):
return self
def docs_cls(self):
return GenericDoc
def docs_namespace(self):
return None # No namespace defined
def docs_lang(self):
return None # ISO 639-1 language code, or None for multiple/other/unknown
class BaseQueries:
PREFIX = 'queries_'
EXTENSIONS = {}
def __getattr__(self, attr):
if attr.startswith(self.PREFIX) and attr in self.EXTENSIONS:
# Return method bound to this instance
return types.MethodType(self.EXTENSIONS[attr], self)
raise AttributeError(attr)
def queries_iter(self):
raise NotImplementedError()
def queries_handler(self):
return self
def queries_cls(self):
return GenericQuery
def queries_namespace(self):
return None # No namespace defined
def queries_lang(self):
return None # ISO 639-1 language code, or None for multiple/other/unknown
class BaseQrels:
PREFIX = 'qrels_'
EXTENSIONS = {}
def __getattr__(self, attr):
if attr.startswith(self.PREFIX) and attr in self.EXTENSIONS:
# Return method bound to this instance
return types.MethodType(self.EXTENSIONS[attr], self)
raise AttributeError(attr)
def qrels_iter(self):
raise NotImplementedError()
def qrels_defs(self):
raise NotImplementedError()
def qrels_path(self):
raise NotImplementedError()
def qrels_cls(self):
return GenericQrel
def qrels_handler(self):
return self
class BaseScoredDocs:
PREFIX = 'scoreddocs_'
EXTENSIONS = {}
def __getattr__(self, attr):
if attr.startswith(self.PREFIX) and attr in self.EXTENSIONS:
# Return method bound to this instance
return types.MethodType(self.EXTENSIONS[attr], self)
raise AttributeError(attr)
def scoreddocs_path(self):
raise NotImplementedError()
def scoreddocs_iter(self):
raise NotImplementedError()
def scoreddocs_cls(self):
return GenericScoredDoc
def scoreddocs_handler(self):
return self
class BaseDocPairs:
PREFIX = 'docpairs_'
EXTENSIONS = {}
def __getattr__(self, attr):
if attr.startswith(self.PREFIX) and attr in self.EXTENSIONS:
# Return method bound to this instance
return types.MethodType(self.EXTENSIONS[attr], self)
raise AttributeError(attr)
def docpairs_path(self):
raise NotImplementedError()
def docpairs_iter(self):
raise NotImplementedError()
def docpairs_cls(self):
return GenericDocPair
def docpairs_handler(self):
return self
class BaseQlogs:
PREFIX = 'qlogs_'
EXTENSIONS = {}
def __getattr__(self, attr):
if attr.startswith(self.PREFIX) and attr in self.EXTENSIONS:
# Return method bound to this instance
return types.MethodType(self.EXTENSIONS[attr], self)
raise AttributeError(attr)
def qlogs_iter(self):
raise NotImplementedError()
def qlogs_cls(self):
raise NotImplementedError()
def qlogs_count(self):
raise NotImplementedError()
def qlogs_handler(self):
return self
BaseQueries.EXTENSIONS['queries_dict'] = lambda x: {q.query_id: q for q in x.iter_queries()}
def qrels_dict(qrels_handler):
result = {}
for qrel in qrels_handler.qrels_iter():
if qrel.query_id not in result:
result[qrel.query_id] = {}
result[qrel.query_id][qrel.doc_id] = qrel.relevance
return result
BaseQrels.EXTENSIONS['qrels_dict'] = qrels_dict
def hasher(iter_fn, hashfn=hashlib.md5):
def wrapped(self):
h = hashfn()
for record in getattr(self, iter_fn)():
js = [[field, value] for field, value in zip(record._fields, record)]
h.update(json.dumps(js).encode())
return h.hexdigest()
return wrapped
BaseDocs.EXTENSIONS['docs_hash'] = hasher('docs_iter')
BaseQueries.EXTENSIONS['queries_hash'] = hasher('queries_iter')
BaseQrels.EXTENSIONS['qrels_hash'] = hasher('qrels_iter')
BaseScoredDocs.EXTENSIONS['scoreddocs_hash'] = hasher('scoreddocs_iter')
BaseDocPairs.EXTENSIONS['docpairs_hash'] = hasher('docpairs_iter')
def _calc_metadata(iter_fn, metadata_fields=(), count_by_value_field=None):
def wrapped(self, verbose=True, hashfn=hashlib.sha256):
count = 0
it = getattr(self, iter_fn)()
if verbose:
it = _logger.pbar(it)
field_lens = {f: 0 for f in metadata_fields}
field_prefixes = {}
count_by_field_values = {}
for record in it:
count += 1
for f in metadata_fields:
field = getattr(record, f)
field_lens[f] = max(field_lens[f], len(field.encode()))
if f not in field_prefixes:
field_prefixes[f] = field
elif len(field_prefixes[f]) > 0:
field_prefixes[f] = ''.join(x[0] for x in itertools.takewhile(lambda x: x[0] == x[1], zip(field_prefixes[f], field)))
if count_by_value_field is not None:
count_by_value_field_value = getattr(record, count_by_value_field)
if count_by_value_field_value not in count_by_field_values:
count_by_field_values[count_by_value_field_value] = 0
count_by_field_values[count_by_value_field_value] += 1
result = {'count': count}
if metadata_fields:
result['fields'] = {}
for f in metadata_fields:
result['fields'][f] = {
'max_len': field_lens[f],
'common_prefix': field_prefixes[f],
}
if count_by_value_field is not None:
result.setdefault('fields', {}).setdefault(count_by_value_field, {})['counts_by_value'] = count_by_field_values
return result
return wrapped
BaseDocs.EXTENSIONS['docs_calc_metadata'] = _calc_metadata('docs_iter', ('doc_id',))
BaseQueries.EXTENSIONS['queries_calc_metadata'] = _calc_metadata('queries_iter')
BaseQrels.EXTENSIONS['qrels_calc_metadata'] = _calc_metadata('qrels_iter', count_by_value_field='relevance')
BaseScoredDocs.EXTENSIONS['scoreddocs_calc_metadata'] = _calc_metadata('scoreddocs_iter')
BaseDocPairs.EXTENSIONS['docpairs_calc_metadata'] = _calc_metadata('docpairs_iter')
BaseQlogs.EXTENSIONS['qlogs_calc_metadata'] = _calc_metadata('qlogs_iter')
class DocstoreBackedDocs(BaseDocs):
"""
A Docs implementation that defers all operations to a pre-built docstore instance.
"""
def __init__(self, docstore_lazy, docs_cls=GenericDoc, namespace=None, lang=None):
self._docstore_lazy = docstore_lazy
self._loaded_docstore = False
self._docs_cls = docs_cls
self._docs_namespace = namespace
self._docs_lang = lang
def docs_iter(self):
return iter(self._docstore_lazy())
def docs_count(self):
if self._loaded_docstore and self.docs_store().built():
return self.docs_store().count()
def docs_cls(self):
return self._docs_cls
def docs_namespace(self):
return self._docs_namespace
def docs_lang(self):
return self._docs_lang
def docs_store(self):
result = self._docstore_lazy()
self._loaded_docstore = True
return result
class DocSourceSeekableIter:
def __next__(self) -> NamedTuple:
"""
Returns the next document encountered
"""
raise NotImplementedError()
def seek(self, pos):
"""
Seeks to the document as `index` pos within the source.
"""
raise NotImplementedError()
def close(self):
"""
Performs any cleanup work when done with this iterator (e.g., close open files)
"""
pass
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
def __iter__(self):
return self
class DocSource:
def __len__(self) -> int:
"""
Returns the number of documents in this source
"""
raise NotImplementedError()
def __iter__(self) -> DocSourceSeekableIter:
"""
Returns a seekable iterator over this source
"""
raise NotImplementedError()
class SourceDocIter:
def __init__(self, docs, slice):
self.docs = docs
self.next_index = 0
self.slice = slice
self.current_iter = None
self.current_start_idx = 0
self.current_end_idx = 0
self.sources = docs.docs_source_iter()
def __next__(self):
if self.slice.start >= self.slice.stop:
raise StopIteration
if self.current_iter is None or self.current_end_idx <= self.slice.start:
# First iteration or no docs remaining in this file
if self.current_iter is not None:
self.current_iter.close()
self.current_iter = None
# jump ahead to the file that contains the desired index
first = True
while first or self.current_end_idx < self.slice.start:
source = next(self.sources)
self.next_index = self.current_end_idx
self.current_start_idx = self.current_end_idx
self.current_end_idx = self.current_start_idx + len(source)
first = False
self.current_iter = iter(source)
if self.next_index != self.slice.start:
self.current_iter.seek(self.slice.start - self.current_start_idx)
result = next(self.current_iter)
self.next_index += 1
self.slice = slice(self.slice.start + (self.slice.step or 1), self.slice.stop, self.slice.step)
return result
def close(self):
if self.current_iter is not None:
self.current_iter.close()
self.current_iter = None
def __iter__(self):
return self
def __del__(self):
self.close()
def __getitem__(self, key):
if isinstance(key, slice):
# it[start:stop:step]
new_slice = ir_datasets.util.apply_sub_slice(self.slice, key)
return SourceDocIter(self.docs, new_slice)
elif isinstance(key, int):
# it[index]
new_slice = ir_datasets.util.slice_idx(self.slice, key)
new_it = SourceDocIter(self.docs, new_slice)
result = next(new_it, StopIteration)
if result is StopIteration:
raise IndexError((self.slice, slice(key, key+1), new_slice))
return result
raise TypeError('key must be int or slice')