torch.autograd.functional.vjp

torch.autograd.functional.vjp(func, inputs, v=None, create_graph=False, strict=False)

计算给定函数在输入点处的雅可比矩阵与向量 v 的点积。

参数

• func (function) – 一个接受 Tensor 输入并返回 Tensor 元组或单个 Tensor 的 Python 函数。

• inputs (Tensor 元组 或 Tensor) – 函数 func 的输入。

• v (Tensor 元组 或 Tensor) – 用于计算向量-雅可比积的向量。必须与 func 的输出大小相同。当 func 的输出只包含一个元素时，此参数是可选的（如果未提供），将被设置为包含单个 1 的 Tensor。

• create_graph (bool, optional) – 如果为 True，则输出和结果都将以可微分的方式计算。请注意，当 strict 为 False 时，结果不能需要梯度或与输入断开连接。默认为 False过去。

• strict (bool, optional) – 如果为 True，则当我们检测到存在某个输入，使得所有输出都与其无关时，将引发错误。如果为 False，则对于这些输入，我们将返回零张量作为其 vjp，这是预期的数学值。默认为 False。

返回

包含以下内容的元组：

func_output (Tensor 元组 或 Tensor)：func(inputs) 的输出

vjp (Tensor 元组 或 Tensor)：点积结果，与输入具有相同形状。

返回类型

output (元组)

示例

>>> def exp_reducer(x):
...     return x.exp().sum(dim=1)
>>> inputs = torch.rand(4, 4)
>>> v = torch.ones(4)
>>> vjp(exp_reducer, inputs, v)
(tensor([5.7817, 7.2458, 5.7830, 6.7782]),
 tensor([[1.4458, 1.3962, 1.3042, 1.6354],
        [2.1288, 1.0652, 1.5483, 2.5035],
        [2.2046, 1.1292, 1.1432, 1.3059],
        [1.3225, 1.6652, 1.7753, 2.0152]]))

>>> vjp(exp_reducer, inputs, v, create_graph=True)
(tensor([5.7817, 7.2458, 5.7830, 6.7782], grad_fn=<SumBackward1>),
 tensor([[1.4458, 1.3962, 1.3042, 1.6354],
        [2.1288, 1.0652, 1.5483, 2.5035],
        [2.2046, 1.1292, 1.1432, 1.3059],
        [1.3225, 1.6652, 1.7753, 2.0152]], grad_fn=<MulBackward0>))

>>> def adder(x, y):
...     return 2 * x + 3 * y
>>> inputs = (torch.rand(2), torch.rand(2))
>>> v = torch.ones(2)
>>> vjp(adder, inputs, v)
(tensor([2.4225, 2.3340]),
 (tensor([2., 2.]), tensor([3., 3.])))