torch.autograd.functional.vjp

torch.autograd.functional.vjp(func, inputs, v=None, create_graph=False, strict=False)[源代码]

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

参数

func（函数）– 一个接受张量输入并返回张量元组或单个张量的 Python 函数。
inputs (元组 of Tensors 或 Tensor) – 传递给函数 func 的输入。
v (元组 of Tensors 或 Tensor) – 用于计算向量雅可比矩阵乘积的向量。必须与 func 的输出大小相同。当 func 的输出只包含一个元素时，此参数是可选的（如果未提供，则默认为包含单个 1 的 Tensor）。
create_graph (bool, 可选) – 如果为 True，则输出和结果将以可微分的方式计算。需要注意的是，当 strict 为 False 时，结果不能需要梯度或与输入断开连接。默认值为 False。
strict (bool, 可选) – 如果设置为True，当检测到存在某个输入使得所有输出与其无关时会引发错误。如果设置为False，对于所述的输入返回一个全零张量作为 vjp，这是数学上的预期值。默认为False。

返回值

包含元组：

func_output (张量的元组或单个张量): func(inputs) 的输出

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

返回类型

输出 (元组)

示例

>>> 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.])))