pytorch / 2 / generated / torch.nn.modules.module.register_module_module_registration_hook.html

torch.nn.modules.module.register_module_module_registration_hook

torch.nn.modules.module.register_module_module_registration_hook(hook) [source]

Registers a module registration hook common to all modules.

Warning

This adds global state to the nn.Module module

The hook will be called every time register_module() is invoked. It should have the following signature:

hook(module, name, submodule) -> None or new submodule

The hook can modify the input or return a single modified value in the hook.

Returns

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

Return type

torch.utils.hooks.RemovableHandle

© 2024, PyTorch Contributors
PyTorch has a BSD-style license, as found in the LICENSE file.
https://pytorch.org/docs/2.1/generated/torch.nn.modules.module.register_module_module_registration_hook.html