torch.func.jacfwd

torch.func.jacfwd(func, argnums=0, has_aux=False, *, randomness='error')

使用前向模式自動微分計算 func 關於索引為 argnum 的參數的 Jacobian 矩陣。

參數

• func (function) – 一個 Python 函式，接受一個或多個參數，其中一個必須是 Tensor，並回傳一個或多個 Tensor。

• argnums (int 或 Tuple[int]) – 可選，整數或整數 tuple，說明要計算關於哪些參數的 Jacobian 矩陣。預設值：0。

• has_aux (bool) – 一個旗標，指示 func 回傳一個 (output, aux) tuple，其中第一個元素是要被微分的函式的輸出，第二個元素是不會被微分的輔助物件。預設值：False。

• randomness (str) – 一個旗標，指示要使用的隨機性類型。有關更多詳細資訊，請參閱 vmap()。允許的值：“different”、“same”、“error”。預設值：“error”。

回傳

回傳一個函式，該函式接受與 func 相同的輸入，並回傳 func 關於 argnums 的參數的 Jacobian 矩陣。 如果 has_aux is True，則回傳的函式會改為回傳一個 (jacobian, aux) tuple，其中 jacobian 是 Jacobian 矩陣，而 aux 是 func 回傳的輔助物件。

注意

您可能會看到此 API 產生錯誤 “operator X 未實作前向模式 AD”。 如果是這樣，請提交錯誤報告，我們會優先處理。 另一種選擇是使用 jacrev()，它具有更好的運算符覆蓋率。

使用點對點一元運算的基礎用法將提供一個對角線陣列作為 Jacobian 矩陣

>>> from torch.func import jacfwd
>>> x = torch.randn(5)
>>> jacobian = jacfwd(torch.sin)(x)
>>> expected = torch.diag(torch.cos(x))
>>> assert torch.allclose(jacobian, expected)

jacfwd() 可以與 vmap 組合以產生批次 Jacobian 矩陣

>>> from torch.func import jacfwd, vmap
>>> x = torch.randn(64, 5)
>>> jacobian = vmap(jacfwd(torch.sin))(x)
>>> assert jacobian.shape == (64, 5, 5)

如果您想計算函式的輸出以及函式的 Jacobian 矩陣，請使用 has_aux 旗標將輸出作為輔助物件回傳

>>> from torch.func import jacfwd
>>> x = torch.randn(5)
>>>
>>> def f(x):
>>>   return x.sin()
>>>
>>> def g(x):
>>>   result = f(x)
>>>   return result, result
>>>
>>> jacobian_f, f_x = jacfwd(g, has_aux=True)(x)
>>> assert torch.allclose(f_x, f(x))

此外，jacrev() 可以與自身或 jacrev() 組合以產生 Hessian 矩陣

>>> from torch.func import jacfwd, jacrev
>>> def f(x):
>>>   return x.sin().sum()
>>>
>>> x = torch.randn(5)
>>> hessian = jacfwd(jacrev(f))(x)
>>> assert torch.allclose(hessian, torch.diag(-x.sin()))

預設情況下，jacfwd() 計算關於第一個輸入的 Jacobian 矩陣。 但是，它可以透過使用 argnums 來計算關於不同參數的 Jacobian 矩陣

>>> from torch.func import jacfwd
>>> def f(x, y):
>>>   return x + y ** 2
>>>
>>> x, y = torch.randn(5), torch.randn(5)
>>> jacobian = jacfwd(f, argnums=1)(x, y)
>>> expected = torch.diag(2 * y)
>>> assert torch.allclose(jacobian, expected)

此外，將 tuple 傳遞給 argnums 將計算關於多個參數的 Jacobian 矩陣

>>> from torch.func import jacfwd
>>> def f(x, y):
>>>   return x + y ** 2
>>>
>>> x, y = torch.randn(5), torch.randn(5)
>>> jacobian = jacfwd(f, argnums=(0, 1))(x, y)
>>> expectedX = torch.diag(torch.ones_like(x))
>>> expectedY = torch.diag(2 * y)
>>> assert torch.allclose(jacobian[0], expectedX)
>>> assert torch.allclose(jacobian[1], expectedY)