Table of Contents
Shortcuts

# torch.nn.modules.module.register_module_forward_pre_hook

torch.nn.modules.module.register_module_forward_pre_hook(hook)

  Registers a forward pre-hook common to all modules.

  Warning

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

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

      hook(module, input) -> None or modified input

  The input contains only the positional arguments given to the module. Keyword arguments won’t be passed to the hooks and only to the `forward`. The hook can modify the input. User can either return a tuple or a single modified value in the hook. We will wrap the value into a tuple if a single value is returned(unless that value is already a tuple).

  This hook has precedence over the specific module hooks registered with `register_forward_pre_hook`.

  Returns:

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

  Return type:

    `torch.utils.hooks.RemovableHandle`

## Docs

Access comprehensive developer documentation for PyTorch

View Docs

## Tutorials

Get in-depth tutorials for beginners and advanced developers

View Tutorials

## Resources

Find development resources and get your questions answered

View Resources

To analyze traffic and optimize your experience, we serve cookies on this site. By clicking or navigating, you agree to allow our usage of cookies. As the current maintainers of this site, Facebook’s Cookies Policy applies. Learn more, including about available controls: Cookies Policy.