tensorplay.nn.modules.module.register_module_full_backward_pre_hook

tensorplay.nn.modules.module.register_module_full_backward_pre_hook(hook: Callable[[Module, tuple[TensorBase, ...] | TensorBase], None | tuple[TensorBase, ...] | TensorBase]) → RemovableHandle[source]

Register a backward pre-hook common to all the modules.

Warning

This adds global state to the nn.module module and it is only intended for debugging/profiling purposes.

Hooks registered using this function behave in the same way as those registered by tensorplay.nn.Module.register_full_backward_pre_hook(). Refer to its documentation for more details.

Hooks registered using this function will be called before hooks registered using tensorplay.nn.Module.register_full_backward_pre_hook().

Returns:

a handle that can be used to remove the added hook by calling handle.remove()

Return type:

tensorplay.utils.hooks.RemovableHandle