NestedIOFunction

class torch.autograd.function.NestedIOFunction(*args, **kwargs)

此类仅出于向后兼容性原因而存在。对于任何新的用例，请改用 Function。

backward(*gradients)

共享的后向工具函数。

返回类型

任意类型

backward_extended(*grad_output)

用户定义的后向。

forward(*args)

共享的前向工具函数。

返回类型

任意类型

forward_extended(*input)

用户定义的前向。

static jvp(ctx, *grad_inputs)

定义使用前向模式自动微分来区分操作的公式。

所有子类都必须重写此函数。它必须接受一个上下文 ctx 作为第一个参数，后跟与 forward() 接收到的输入一样多的参数（对于 forward 函数的非 Tensor 输入，将传入 None），并且它应该返回与 forward() 输出的 Tensor 一样多的 Tensor。每个参数是相对于给定输入的梯度，每个返回值应该是相对于相应输出的梯度。如果输出不是 Tensor 或者函数相对于该输出不可微分，则可以简单地为该输入传递 None 作为梯度。

您可以使用 ctx 对象将 forward 中的任何值传递给此函数。

返回类型

任意类型

mark_dirty(*args, **kwargs)

请参阅 Function.mark_dirty()。

mark_non_differentiable(*args, **kwargs)

请参阅 Function.mark_non_differentiable()。

save_for_backward(*args)

请参阅 Function.save_for_backward()。

save_for_forward(*tensors)

保存给定的 Tensor 以供将来调用 jvp()。

save_for_forward 最多只能调用一次，可以在 setup_context() 或 forward() 方法中调用，并且所有参数都应该是 Tensor。

在 jvp() 中，可以通过 saved_tensors 属性访问保存的对象。

参数也可以是 None。这没有操作。

有关如何使用此方法的更多详细信息，请参阅 扩展 torch.autograd。

示例：

>>> class Func(torch.autograd.Function):
>>>     @staticmethod
>>>     def forward(ctx, x: torch.Tensor, y: torch.Tensor, z: int):
>>>         ctx.save_for_backward(x, y)
>>>         ctx.save_for_forward(x, y)
>>>         ctx.z = z
>>>         return x * y * z
>>>
>>>     @staticmethod
>>>     def jvp(ctx, x_t, y_t, _):
>>>         x, y = ctx.saved_tensors
>>>         z = ctx.z
>>>         return z * (y * x_t + x * y_t)
>>>
>>>     @staticmethod
>>>     def vjp(ctx, grad_out):
>>>         x, y = ctx.saved_tensors
>>>         z = ctx.z
>>>         return z * grad_out * y, z * grad_out * x, None
>>>
>>>     a = torch.tensor(1., requires_grad=True, dtype=torch.double)
>>>     t = torch.tensor(1., dtype=torch.double)
>>>     b = torch.tensor(2., requires_grad=True, dtype=torch.double)
>>>     c = 4
>>>
>>>     with fwAD.dual_level():
>>>         a_dual = fwAD.make_dual(a, t)
>>>         d = Func.apply(a_dual, b, c)

property saved_tensors

请参阅 Function.saved_tensors()。

set_materialize_grads(value)

设置是否具体化（materialize）梯度 Tensor。默认为 True。

这只能在 setup_context() 或 forward() 方法中调用。

如果为 True，则在调用 backward() 和 jvp() 方法之前，未定义的梯度 Tensor 将被扩展为充满零的 Tensor。

示例：

>>> class SimpleFunc(Function):
>>>     @staticmethod
>>>     def forward(ctx, x):
>>>         return x.clone(), x.clone()
>>>
>>>     @staticmethod
>>>     @once_differentiable
>>>     def backward(ctx, g1, g2):
>>>         return g1 + g2  # No check for None necessary
>>>
>>> # We modify SimpleFunc to handle non-materialized grad outputs
>>> class Func(Function):
>>>     @staticmethod
>>>     def forward(ctx, x):
>>>         ctx.set_materialize_grads(False)
>>>         ctx.save_for_backward(x)
>>>         return x.clone(), x.clone()
>>>
>>>     @staticmethod
>>>     @once_differentiable
>>>     def backward(ctx, g1, g2):
>>>         x, = ctx.saved_tensors
>>>         grad_input = torch.zeros_like(x)
>>>         if g1 is not None:  # We must check for None now
>>>             grad_input += g1
>>>         if g2 is not None:
>>>             grad_input += g2
>>>         return grad_input
>>>
>>> a = torch.tensor(1., requires_grad=True)
>>> b, _ = Func.apply(a)  # induces g2 to be undefined

static setup_context(ctx, inputs, output)

定义 autograd.Function 的前向过程有两种方法。

或者

1. 使用签名 forward(ctx, *args, **kwargs) 重写 forward。setup_context 不被重写。为 backward 设置 ctx 发生在 forward 内部。

2. 使用签名 forward(*args, **kwargs) 重写 forward 并重写 setup_context。为 backward 设置 ctx 发生在 setup_context 内部（而非 forward 内部）

有关更多详细信息，请参阅 torch.autograd.Function.forward() 和 扩展 torch.autograd。

返回类型

任意类型

static vjp(ctx, *grad_outputs)

定义使用后向模式自动微分来区分操作的公式。

所有子类都必须重写此函数。（定义此函数等同于定义 vjp 函数。）

它必须接受一个上下文 ctx 作为第一个参数，后跟与 forward() 返回的输出一样多的参数（对于 forward 函数的非 Tensor 输出，将传入 None），并且它应该返回与 forward() 输入的 Tensor 一样多的 Tensor。每个参数是相对于给定输出的梯度，每个返回值应该是相对于相应输入的梯度。如果输入不是 Tensor 或者是不需要梯度的 Tensor，则可以简单地为该输入传递 None 作为梯度。

上下文可用于检索在前向过程中保存的 Tensor。它还有一个属性 ctx.needs_input_grad，它是一个布尔值元组，表示每个输入是否需要梯度。例如，如果 forward() 的第一个输入需要计算相对于输出的梯度，则 backward() 将具有 ctx.needs_input_grad[0] = True。

返回类型

任意类型

static vmap(info, in_dims, *args)

定义此 autograd.Function 在 torch.vmap() 下的行为。

要使 torch.autograd.Function() 支持 torch.vmap()，您必须重写此静态方法，或者将 generate_vmap_rule 设置为 True（两者不能同时进行）。

如果您选择重写此静态方法：它必须接受

• 一个 info 对象作为第一个参数。info.batch_size 指定正在进行 vmap 操作的维度的尺寸，而 info.randomness 是传递给 torch.vmap() 的 randomness 选项。

• 一个 in_dims 元组作为第二个参数。对于 args 中的每个 arg，in_dims 都有一个相应的 Optional[int]。如果 arg 不是 Tensor 或者 arg 未进行 vmap 操作，则为 None；否则，它是一个整数，指定 Tensor 的哪个维度正在进行 vmap 操作。

• *args，与 forward() 的参数相同。

vmap 静态方法的返回值是一个 (output, out_dims) 元组。类似于 in_dims，out_dims 的结构应与 output 相同，并且每个输出包含一个 out_dim，指定输出是否具有 vmap 维度及其所在的索引。

有关更多详细信息，请参阅 使用 autograd.Function 扩展 torch.func。