otx.algo.callbacks.iteration_timer#

Timer for logging iteration time for train, val, and test phases.

Classes

IterationTimer([prog_bar, on_step, on_epoch])

Timer for logging iteration time for train, val, and test phases.

class otx.algo.callbacks.iteration_timer.IterationTimer(prog_bar: bool = True, on_step: bool = True, on_epoch: bool = True)[source]#

Bases: Callback

Timer for logging iteration time for train, val, and test phases.

on_test_batch_end(trainer: Trainer, pl_module: LightningModule, outputs: STEP_OUTPUT, batch: Any, batch_idx: int, dataloader_idx: int = 0) → None[source]#: Log iteration time on the test batch end.

on_test_batch_start(trainer: Trainer, pl_module: LightningModule, batch: Any, batch_idx: int, dataloader_idx: int = 0) → None[source]#: Log iteration data time on the test batch start.

on_test_epoch_start(trainer: Trainer, pl_module: LightningModule) → None[source]#: Reset timer before every test epoch starts.

on_train_batch_end(trainer: Trainer, pl_module: LightningModule, outputs: STEP_OUTPUT, batch: Any, batch_idx: int) → None[source]#: Log iteration time on the training batch end.

on_train_batch_start(trainer: Trainer, pl_module: LightningModule, batch: Any, batch_idx: int) → None[source]#: Log iteration data time on the training batch start.

on_train_epoch_start(trainer: Trainer, pl_module: LightningModule) → None[source]#: Reset timer before every train epoch starts.

on_validation_batch_end(trainer: Trainer, pl_module: LightningModule, outputs: STEP_OUTPUT, batch: Any, batch_idx: int, dataloader_idx: int = 0) → None[source]#: Log iteration time on the validation batch end.

on_validation_batch_start(trainer: Trainer, pl_module: LightningModule, batch: Any, batch_idx: int, dataloader_idx: int = 0) → None[source]#: Log iteration data time on the validation batch start.

on_validation_epoch_start(trainer: Trainer, pl_module: LightningModule) → None[source]#: Reset timer before every validation epoch starts.