torch.func.grad

torch.func.grad(func, argnums=0, has_aux=False)

grad 操作符有助于计算 func 相对于由 argnums 指定的输入的梯度。此操作符可以嵌套使用以计算高阶导数。

参数

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 值对应的输出梯度元组。

返回类型

Callable

使用grad的示例：

>>> from torch.func import grad
>>> x = torch.randn([])
>>> cos_x = grad(lambda x: torch.sin(x))(x)
>>> assert torch.allclose(cos_x, x.cos())
>>>
>>> # Second-order gradients
>>> neg_sin_x = grad(grad(lambda x: torch.sin(x)))(x)
>>> assert torch.allclose(neg_sin_x, -x.sin())

当与vmap结合使用时，grad可以用来计算每个样本的梯度。

>>> from torch.func import grad, vmap
>>> batch_size, feature_size = 3, 5
>>>
>>> def model(weights, feature_vec):
>>>     # Very simple linear model with activation
>>>     assert feature_vec.dim() == 1
>>>     return feature_vec.dot(weights).relu()
>>>
>>> def compute_loss(weights, example, target):
>>>     y = model(weights, example)
>>>     return ((y - target) ** 2).mean()  # MSELoss
>>>
>>> weights = torch.randn(feature_size, requires_grad=True)
>>> examples = torch.randn(batch_size, feature_size)
>>> targets = torch.randn(batch_size)
>>> inputs = (weights, examples, targets)
>>> grad_weight_per_example = vmap(grad(compute_loss), in_dims=(None, 0, 0))(*inputs)

使用grad、has_aux和argnums的示例：

>>> from torch.func import grad
>>> def my_loss_func(y, y_pred):
>>>    loss_per_sample = (0.5 * y_pred - y) ** 2
>>>    loss = loss_per_sample.mean()
>>>    return loss, (y_pred, loss_per_sample)
>>>
>>> fn = grad(my_loss_func, argnums=(0, 1), has_aux=True)
>>> y_true = torch.rand(4)
>>> y_preds = torch.rand(4, requires_grad=True)
>>> out = fn(y_true, y_preds)
>>> # > output is ((grads w.r.t y_true, grads w.r.t y_preds), (y_pred, loss_per_sample))

注意

结合使用 PyTorch 的 torch.no_grad 和 grad。

情况1：在函数中使用torch.no_grad:

>>> def f(x):
>>>     with torch.no_grad():
>>>         c = x ** 2
>>>     return x - c

在这种情况下，grad(f)(x) 会遵守内部的 torch.no_grad。

情况2：在torch.no_grad上下文中使用grad：

>>> with torch.no_grad():
>>>     grad(f)(x)

在这种情况下，grad 将会尊重内部的 torch.no_grad，但不尊重外部的。这是因为 grad 是一个“函数变换”，其结果不应依赖于 f 之外的上下文管理器。