Source code for capreolus.index

from capreolus import Dependency, ModuleBase, get_logger

[docs]logger = get_logger(__name__) # pylint: disable=invalid-name
[docs]class Index(ModuleBase): """Base class for Index modules. The purpose of an Index module is to represent an inverted index that can be queried with a :class:`~capreolus.searcher.Searcher` module and used to obtain documents and collection statistics. Modules should provide: - a ``_create_index`` method that creates an index on the ``Collection`` dependency - a ``get_doc(docid)`` and a ``get_docs(docid)`` method - a ``get_df(term)`` method """
[docs] module_type = "index"
[docs] dependencies = [Dependency(key="collection", module="collection")]
[docs] def get_index_path(self): return self.get_cache_path() / "index"
[docs] def exists(self): donefn = self.get_index_path() / "done" return donefn.exists()
[docs] def create_index(self): if self.exists(): return self._create_index() donefn = self.get_index_path() / "done" with open(donefn, "wt") as donef: print("done", file=donef)
def _create_index(self): raise NotImplementedError()
[docs] def get_doc(self, doc_id): raise NotImplementedError()
[docs] def get_docs(self, doc_ids): raise NotImplementedError()
from profane import import_all_modules from .anserini import AnseriniIndex import_all_modules(__file__, __package__)