嵌套 IO 函数 ¶

类 torch.autograd.function.NestedIOFunction(*args, **kwargs)[source][source] ¶

此类仅用于向后兼容原因。对于任何新的用例，请使用 Function 替代此功能。

向后(*梯度)[来源][来源] ¶

共享向后实用工具。

返回类型:

任何

扩展向后(*grad_output)[来源][来源] ¶

用户定义的向后。

forward(*args)

共享前向实用工具。

返回类型:

任何

forward_extended(*input)

用户定义的前向。

static jvp(ctx, *grad_inputs)

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

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

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

返回类型:

任何

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 方法， forward(ctx, *args, **kwargs) 不会被覆盖。设置 ctx 以进行反向传播发生在 forward 内部。

2. 使用签名 forward(*args, **kwargs) 覆盖前进，并使用 setup_context 覆盖。设置 ctx 用于反向操作发生在 setup_context 内（而不是在 forward 内）

请参阅 torch.autograd.Function.forward() 和扩展 torch.autograd 以获取更多详细信息。

返回类型:

任何

static vjp(ctx, *grad_outputs)[source]

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

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

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

可以使用上下文来检索正向传递期间保存的张量。它还有一个属性 ctx.needs_input_grad ，表示为布尔值的元组，表示每个输入是否需要计算相对于输出的梯度。例如， backward() 将包含 ctx.needs_input_grad[0] = True ，如果 forward() 的第一个输入需要计算相对于输出的梯度。

返回类型:

任何

static vmap(info, in_dims, *args)[source]

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

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

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

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

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

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

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

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