LightningIRConfigClassFactory

class lightning_ir.base.class_factory.LightningIRConfigClassFactory(MixinConfig: Type[LightningIRConfig])[source]

Bases: LightningIRClassFactory

Class factory for creating derived LightningIRConfig classes from HuggingFace configuration classes.

Methods

`from_backbone_class`(BackboneClass)	Creates a derived LightningIRConfig from a transformers.PretrainedConfig backbone configuration class.
`from_pretrained`(model_name_or_path, *args, ...)	Loads a derived LightningIRConfig from a pretrained HuggingFace model.

from_backbone_class(BackboneClass: Type[PretrainedConfig]) → Type[LightningIRConfig][source]

Creates a derived LightningIRConfig from a transformers.PretrainedConfig backbone configuration class. If the backbone configuration class is already a derived LightningIRConfig, it is returned as is.

Parameters:: BackboneClass (Type[PretrainedConfig]) – Backbone configuration class.
Returns:: Derived LightningIRConfig.
Return type:: Type[LightningIRConfig]

from_pretrained(model_name_or_path: str | Path, *args, **kwargs) → Type[LightningIRConfig][source]

Loads a derived LightningIRConfig from a pretrained HuggingFace model.

Parameters:: model_name_or_path (str | Path) – Path to the model or its name.
Returns:: Derived LightningIRConfig.
Return type:: Type[LightningIRConfig]