functorch.grad_and_value

functorch.grad_and_value(func, argnums=0, has_aux=False)

返回一個函數，用於計算梯度和原始計算（或前向計算）的元組。

參數

• func (Callable) – 一個 Python 函式，可接受一個或多個參數。必須回傳單元素張量。如果指定的 has_aux 等於 True，函式可以回傳單元素張量和其他輔助物件的元組：(output, aux)。

• argnums (int 或 Tuple[int]) – 指定要計算梯度的參數。 argnums 可以是單個整數或整數元組。預設值：0。

• has_aux (bool) – 標記 func 是否回傳張量和其他輔助物件的旗標：(output, aux)。預設值：False。

回傳值

用於計算關於其輸入和前向計算的梯度元組的函式。預設情況下，函式的輸出是關於第一個參數的梯度張量元組和原始計算結果的元組。如果指定的 has_aux 等於 True，則會回傳梯度元組和包含輸出輔助物件的前向計算結果的元組。如果 argnums 是一個整數元組，則會回傳一個元組，其中包含關於每個 argnums 值的輸出梯度元組和前向計算結果的元組。

有關範例，請參閱 grad()

警告

我們已將 functorch 整合到 PyTorch 中。作為整合的最後一步，functorch.grad_and_value 從 PyTorch 2.0 開始已被棄用，並將在 PyTorch >= 2.3 的未來版本中刪除。請改用 torch.func.grad_and_value；有關更多詳細資訊，請參閱 PyTorch 2.0 版本說明和/或 torch.func 遷移指南 https://pytorch.dev.org.tw/docs/master/func.migrating.html