topobench.callbacks.timer_callback module#

TopoBench: A library for benchmarking topological models.

class PipelineTimer#

Bases: Callback

Measures and logs average execution times of training, validation, and testing stages.

__init__()#

Initialize dictionaries to store accumulated times and counts.

on_test_batch_end(*args)#

End timing a test batch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_test_batch_start(*args)#

Start timing a test batch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_test_epoch_end(*args)#

End timing a test epoch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_test_epoch_start(*args)#

Start timing a test epoch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_train_batch_end(*args)#

End timing a training batch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_train_batch_start(*args)#

Start timing a training batch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_train_end(trainer, *args)#

Log the average times at the end of training.

Parameters:
trainerobject

The PyTorch Lightning trainer instance used for logging.

*argstuple

Additional arguments passed by the trainer.

on_train_epoch_end(*args)#

End timing a training epoch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_train_epoch_start(*args)#

Start timing a training epoch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_validation_batch_end(*args)#

End timing a validation batch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_validation_batch_start(*args)#

Start timing a validation batch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_validation_epoch_end(*args)#

End timing a validation epoch.

Parameters:
*argstuple

Additional arguments passed by the trainer.

on_validation_epoch_start(*args)#

Start timing a validation epoch.

Parameters:
*argstuple

Additional arguments passed by the trainer.