Class Module

sparsh/tactile_ssl/algorithm/module.py:11–50

class Module(ABC):
    @abstractmethod
    def training_step(self, batch: Dict[str, Any], batch_idx: int) -> Dict:
        raise NotImplementedError

    @abstractmethod
    def validation_step(self, batch: Dict[str, Any], batch_idx: int) -> Dict:
        raise NotImplementedError

    @abstractmethod
    def configure_optimizers(
        self, num_iterations_per_epoch: int, num_epochs: int
    ) -> Tuple[
        torch.optim.Optimizer,
        Optional[Dict],
        Optional[Dict],
    ]:
        raise NotImplementedError

    def on_train_epoch_end(self, trainer_instance=None):
        pass

    def on_validation_epoch_end(self, trainer_instance=None):
        pass

    def on_train_batch_end(
        self, outputs: Dict, batch: Dict, batch_idx: int, trainer_instance=None
    ):
        pass

    def on_validation_batch_end(
        self, outputs: Dict, batch: Dict, batch_idx: int, trainer_instance=None
    ):
        pass

    def on_train_batch_start(self, batch: Dict, batch_idx: int):
        pass

    def on_train_epoch_start(self, trainer_instance=None):
        pass