Skip to content

Pytorch

PyTorch Trainer Mixin

PyTorchTrainerProtocol

Bases: Protocol

Source code in src/fed_rag/trainers/pytorch/mixin.py 
16
17
18
19
20
21
22
23
@runtime_checkable
class PyTorchTrainerProtocol(Protocol):
    train_dataset: Dataset
    training_arguments: TrainingArgs | None
    train_dataloader: DataLoader

    def model(self) -> nn.Module:
        pass  # pragma: no cover

PyTorchTrainerMixin

Bases: BaseModel, ABC

HuggingFace Trainer Mixin.

Source code in src/fed_rag/trainers/pytorch/mixin.py 
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
class PyTorchTrainerMixin(BaseModel, ABC):
    """HuggingFace Trainer Mixin."""

    model_config = ConfigDict(
        arbitrary_types_allowed=True,
    )
    train_dataset: Dataset
    train_dataloader: DataLoader
    training_arguments: TrainingArgs | None = None

    def __init__(
        self,
        train_dataloader: DataLoader,
        train_dataset: Dataset | None = None,
        training_arguments: TrainingArgs | None = None,
        **kwargs: Any,
    ):
        if train_dataset is None:
            train_dataset = train_dataloader.dataset
        else:
            # ensure consistency between loader.dataset and the supplied one
            if id(train_dataset) != id(train_dataloader.dataset):
                raise InconsistentDatasetError(
                    "Inconsistent datasets detected between supplied `train_dataset` and that "
                    "associated with the `train_dataloader`. These two datasets must be the same."
                )

        super().__init__(
            train_dataset=train_dataset,
            train_dataloader=train_dataloader,
            training_arguments=training_arguments,
            **kwargs,
        )