capreolus.collection.msmarco
¶
Module Contents¶
Classes¶
Base class for Collection modules. The purpose of a Collection is to describe a document collection's location and its format. |
Attributes¶
- class capreolus.collection.msmarco.MSMarcoPsg(config=None, provide=None, share_dependency_objects=False, build=True)[source]¶
Bases:
capreolus.collection.Collection
,MSMarcoMixin
Base class for Collection modules. The purpose of a Collection is to describe a document collection’s location and its format.
- Determining the document collection’s location on disk:
The path config option will be used if it contains a valid loation.
If not, the
_path
attribute is used if it is valid. This is primarily used withDummyCollection
.If not, the class’
download_if_missing
method will be called.
- Modules should provide:
the
collection_type
andgenerator_type
class attributes, corresponding to Anserini typesa
download_if_missing
method, if the collection is publicly availablea
_validate_document_path
method. Seevalidate_document_path()
.