functorch.jacfwd

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

使用前向模式自动微分计算 func 相对于索引 argnum 处的参数的雅可比矩阵。

参数

• func (函数) – 一个 Python 函数，它接受一个或多个参数，其中一个必须是张量，并返回一个或多个张量。

• argnums (int 或 元组[int]) – 可选的，整数或整数元组，表示要计算雅可比矩阵的相应参数。默认值：0。

• has_aux (bool) – 标志，指示 func 是否返回一个 (output, aux) 元组，其中第一个元素是函数的输出（要进行微分的），第二个元素是不会进行微分的辅助对象。默认值：False。

• randomness (str) – 标志，指示要使用哪种类型的随机性。有关更多详细信息，请参见 vmap()。允许值：“different”、“same”、“error”。默认值：“error”。

返回值

返回一个函数，该函数接受与 func 相同的输入，并返回 func 相对于索引 argnums 处的参数的雅可比矩阵。如果 has_aux is True，则返回的函数返回一个 (jacobian, aux) 元组，其中 jacobian 是雅可比矩阵，而 aux 是 func 返回的辅助对象。

注意

您可能会看到此 API 出现错误，提示“操作符 X 未实现前向模式 AD”。如果是这种情况，请提交错误报告，我们会优先处理。另一种选择是使用 jacrev()，它具有更好的操作符覆盖范围。

使用逐点、一元运算的基本用法将产生一个对角矩阵作为雅可比矩阵。

>>> 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 组合，以生成批处理雅可比矩阵。

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

如果您希望计算函数的输出以及函数的雅可比矩阵，请使用 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() 组合，以生成海森矩阵。

>>> 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() 计算相对于第一个输入的雅可比矩阵。但是，它可以通过使用 argnums 计算相对于不同参数的雅可比矩阵。

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

此外，将元组传递给 argnums 将计算相对于多个参数的雅可比矩阵。

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

警告

我们已将 functorch 集成到 PyTorch 中。作为集成的最后一步，从 PyTorch 2.0 开始，functorch.jacfwd 已弃用，将在 PyTorch >= 2.3 的未来版本中删除。请改用 torch.func.jacfwd；有关更多详细信息，请参阅 PyTorch 2.0 版本说明或 torch.func 迁移指南 https://pytorch.ac.cn/docs/master/func.migrating.html