CrossEncoderModel
- class lightning_ir.cross_encoder.model.CrossEncoderModel(config: CrossEncoderConfig, *args, **kwargs)[source]
Bases:
LightningIRModel
- __init__(config: CrossEncoderConfig, *args, **kwargs)[source]
Methods
__init__
(config, *args, **kwargs)forward
(encoding)from_pretrained
(model_name_or_path, *args, ...)Loads a pretrained model.
Attributes
ALLOW_SUB_BATCHING
Flag to allow mini batches of documents for a single query.
- classmethod from_pretrained(model_name_or_path: str | Path, *args, **kwargs) LightningIRModel
Loads a pretrained model. Wraps the transformers.PreTrainedModel.from_pretrained method and to return a derived LightningIRModel. See
LightningIRModelClassFactory
for more details.- Parameters:
model_name_or_path (str | Path) – Name or path of the pretrained model
- Raises:
ValueError – If called on the abstract class
LightningIRModel
and no config is passed- Returns:
A derived LightningIRModel consisting of a backbone model and a LightningIRModel mixin
- Return type:
>>> # Loading using model class and backbone checkpoint >>> type(CrossEncoderModel.from_pretrained("bert-base-uncased")) <class 'lightning_ir.base.class_factory.CrossEncoderBertModel'> >>> # Loading using base class and backbone checkpoint >>> type(LightningIRModel.from_pretrained("bert-base-uncased", config=CrossEncoderConfig())) <class 'lightning_ir.base.class_factory.CrossEncoderBertModel'>