torch.autograd.functional.vjp

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

計算向量 v 與給定函數在輸入點的 Jacobian 矩陣的點積。

參數

• func (function) – 一個 Python 函數，它接受 Tensor 輸入並返回一個 Tensors 元組或一個 Tensor。

• inputs (Tensors 的元組或Tensor) – 函數 func 的輸入。

• v (Tensors 的元組或Tensor) – 用於計算向量 Jacobian 乘積的向量。必須與 func 的輸出大小相同。當 func 的輸出包含單個元素時，此參數是可選的，並且（如果未提供）將設置為包含單個 1 的 Tensor。

• create_graph (bool, optional) – 如果 True，則輸出和結果都將以可微分的方式計算。請注意，當 strict 為 False 時，結果不能要求梯度或與輸入斷開連接。預設為 False。

• strict (bool, optional) – 如果 True，當我們檢測到存在一個輸入，使得所有輸出都與它無關時，將引發錯誤。如果 False，我們會為所述輸入返回一個零 Tensor 作為 vjp，這是預期的數學值。預設為 False。

返回

包含以下元素的元組：

func_output (Tensors 的元組或 Tensor): func(inputs) 的輸出

vjp (Tensors 的元組或 Tensor): 與輸入具有相同形狀的點積結果。

返回類型

output (tuple)

範例

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