torch.nn.modules.module.register_module_forward_hook

torch.nn.modules.module.register_module_forward_hook(hook, *, with_kwargs=False, always_call=False)

为所有模块注册一个全局前向钩子。

警告

这会向 nn.module 模块添加全局状态，仅用于调试/性能分析目的。

该钩子会在 forward() 计算出输出后每次被调用。它应该具有以下签名

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

输入只包含传递给模块的位置参数。关键字参数不会传递给钩子，只会传递给 forward。您可以通过返回一个新值来选择性地修改模块的输出，该新值将替换 forward() 函数的输出。

参数

• hook (Callable) – 要注册的用户定义钩子。

• always_call (bool) – 如果为 True，则无论调用模块时是否抛出异常，都会运行该 hook。默认值：False

返回值

一个句柄，通过调用 handle.remove() 可以移除添加的钩子。

返回类型

torch.utils.hooks.RemovableHandle

该钩子将在使用 register_forward_hook 注册的特定模块钩子之前执行。