Deep learning for NeuroImaging in Python.

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the gallery for the big picture.

class nidl.callbacks.check_typing.BatchTypingCallback[source]¶

Bases: Callback

This callback allows you to check the batch format based on the method signature.

Raises:

TypeError

If function parameters are not annotated.

TraitError

If the input value have incorrect type.

NotImplementedError

If a type is not handled by the code.

on_predict_batch_start(trainer, pl_module, batch, batch_idx, dataloader_idx=0)[source]¶: Called when the predict batch begins.

on_test_batch_start(trainer, pl_module, batch, batch_idx, dataloader_idx=0)[source]¶: Called when the test batch begins.

on_train_batch_start(trainer, pl_module, batch, batch_idx)[source]¶: Called when the train batch begins.

on_validation_batch_start(trainer, pl_module, batch, batch_idx, dataloader_idx=0)[source]¶: Called when the validation batch begins.