torch.autograd.function.FunctionCtx.save_for_backward#
- FunctionCtx.save_for_backward(tensors)[source]#
为未来的
backward()
调用保存给定的张量。save_for_backward
应被调用最多一次,在setup_context()
或forward()
方法中,并且仅使用张量。所有打算在反向传播中使用的张量都应使用
save_for_backward
(而不是直接放在ctx
上)来保存,以防止不正确的梯度和内存泄漏,并启用已保存张量钩子的应用。请参阅torch.autograd.graph.saved_tensors_hooks
。更多详情请参阅 扩展 torch.autograd。请注意,如果保存了中间张量(非
forward()
的输入或输出的张量)以用于反向传播,您的自定义 Function 可能不支持二次反向传播。不支持二次反向传播的自定义 Function 应使用@once_differentiable
装饰它们的backward()
方法,以便在执行二次反向传播时引发错误。如果您想支持二次反向传播,您可以在反向传播期间根据输入重新计算中间值,或者将中间值作为自定义 Function 的输出返回。有关更多详细信息,请参阅 二次反向传播教程。在
backward()
中,可以通过saved_tensors
属性访问已保存的张量。在将它们返回给用户之前,会进行检查以确保它们没有被用于任何修改了其内容的就地操作。参数也可以是
None
。这不会执行任何操作。有关如何使用此方法的更多详细信息,请参阅 扩展 torch.autograd。
示例
>>> class Func(Function): >>> @staticmethod >>> def forward(ctx, x: torch.Tensor, y: torch.Tensor, z: int): >>> w = x * z >>> out = x * y + y * z + w * y >>> ctx.save_for_backward(x, y, w, out) >>> ctx.z = z # z is not a tensor >>> return out >>> >>> @staticmethod >>> @once_differentiable >>> def backward(ctx, grad_out): >>> x, y, w, out = ctx.saved_tensors >>> z = ctx.z >>> gx = grad_out * (y + y * z) >>> gy = grad_out * (x + z + w) >>> gz = None >>> return gx, gy, gz >>> >>> a = torch.tensor(1., requires_grad=True, dtype=torch.double) >>> b = torch.tensor(2., requires_grad=True, dtype=torch.double) >>> c = 4 >>> d = Func.apply(a, b, c)