NestedIOFunction

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

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

backward(*gradients)

共享的反向实用程序。

返回类型

Any

backward_extended(*grad_output)

用户定义的反向传播。

forward(*args)

共享的正向实用程序。

返回类型

Any

forward_extended(*input)

用户定义的正向传播。

static jvp(ctx, *grad_inputs)

定义使用前向模式自动微分对操作进行微分的公式。

此函数需要被所有子类重写。它必须接受一个上下文 ctx 作为第一个参数，后跟与 forward() 获取的输入数量相同的输入（对于 forward 函数的非张量输入，将传入 None），并且它应该返回与 forward() 的输出数量相同的张量。每个参数是关于给定输入的梯度，每个返回值应该是关于相应输出的梯度。如果输出不是张量，或者该函数对于该输出不可微分，则可以仅将 None 作为该输入的梯度传递。

您可以使用 ctx 对象将任何值从 forward 传递到此函数。

返回类型

Any

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)

保存给定的张量，以便将来调用 jvp()。

save_for_forward 应该最多调用一次，无论是在 setup_context() 还是 forward() 方法中，并且所有参数都应该是张量。

在 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)

设置是否要实体化梯度张量。默认为 True。

应该仅从 setup_context() 或 forward() 方法中调用此方法。

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

示例：

>>> 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 不会被重写。为反向传播设置 ctx 在 forward 内部进行。

2. 使用签名 forward(*args, **kwargs) 重写 forward，并重写 setup_context。为反向传播设置 ctx 在 setup_context 内部进行（而不是在 forward 内部）

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

返回类型

Any

static vjp(ctx, *grad_outputs)

定义使用反向模式自动微分对操作进行微分的公式。

此函数需要被所有子类重写。（定义此函数等效于定义 vjp 函数。）

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

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

返回类型

Any

static vmap(info, in_dims, *args)

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

对于要支持 torch.vmap() 的 torch.autograd.Function()，您必须重写此静态方法，或将 generate_vmap_rule 设置为 True（您不能同时执行这两项操作）。

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

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

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

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

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

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