Skip to content

base_model

BaseModel

Bases: LightningModule

Base class for DL model.

Source code in lightning_boost/models/base_model.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class BaseModel(LightningModule):
    """Base class for DL model."""

    def __init__(self, name: str | None = None) -> None:
        super().__init__()
        self.name = name

    def forward(self, *args: Tensor) -> Tensor | Sequence[Tensor]:
        """
        Performs forward pass.

        Args:
            Tensor: Inputs.

        Raises:
            NotImplementedError: Needs to be implemented for a concrete DL model.

        Returns:
            Tensor | Sequence[Tensor]: Predictions.
        """

        raise NotImplementedError

forward(*args)

Performs forward pass.

Parameters:

Name Type Description Default
Tensor

Inputs.

 required

Raises:

Type Description
NotImplementedError

Needs to be implemented for a concrete DL model.

Returns:

Type Description
Tensor | Sequence[Tensor]

Tensor | Sequence[Tensor]: Predictions.
Source code in lightning_boost/models/base_model.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def forward(self, *args: Tensor) -> Tensor | Sequence[Tensor]:
    """
    Performs forward pass.

    Args:
        Tensor: Inputs.

    Raises:
        NotImplementedError: Needs to be implemented for a concrete DL model.

    Returns:
        Tensor | Sequence[Tensor]: Predictions.
    """

    raise NotImplementedError