torch.Tensor.register_post_accumulate_grad_hook

Tensor.register_post_accumulate_grad_hook(hook)

注册一个在梯度累积后运行的反向钩子。

该钩子将在所有梯度累积完成后调用，这意味着 .grad 字段已在此张量上更新。post accumulate grad 钩子仅适用于叶子张量（没有 .grad_fn 字段的张量）。在非叶子张量上注册此钩子将报错！

钩子应具有以下签名

hook(param: Tensor) -> None

请注意，与其他 autograd 钩子不同，此钩子作用于需要梯度的张量本身，而不是梯度。该钩子可以就地修改和访问其 Tensor 参数，包括其 .grad 字段。

此函数返回一个句柄，其中包含一个方法 handle.remove()，用于从模块中移除该钩子。

注意

有关此钩子何时执行以及其执行顺序相对于其他钩子的信息，请参阅 Backward Hooks execution。由于此钩子在反向传播期间运行，因此它将在 no_grad 模式下运行（除非 create_graph 为 True）。如果需要，您可以在钩子中使用 torch.enable_grad() 重新启用 autograd。

示例

>>> v = torch.tensor([0., 0., 0.], requires_grad=True)
>>> lr = 0.01
>>> # simulate a simple SGD update
>>> h = v.register_post_accumulate_grad_hook(lambda p: p.add_(p.grad, alpha=-lr))
>>> v.backward(torch.tensor([1., 2., 3.]))
>>> v
tensor([-0.0100, -0.0200, -0.0300], requires_grad=True)

>>> h.remove()  # removes the hook