torch.func API 参考¶

函数变换¶

`vmap`	vmap 是向量化映射；`vmap(func)` 返回一个新函数，该函数在输入的某个维度上映射 `func`。
`grad`	`grad` 操作符有助于计算 `func` 相对于由 `argnums` 指定的输入的梯度。
`grad_and_value`	返回一个函数来计算梯度和原始（或正向）计算的元组。
`vjp`	代表向量-雅可比乘积，返回包含应用于 `primals` 的 `func` 的结果以及一个函数的元组，该函数在给定 `cotangents` 时，计算 `func` 相对于 `primals` 的反向模式雅可比乘以 `cotangents`。
`jvp`	代表雅可比-向量乘积，返回包含 func(*primals) 的输出以及“在 `primals` 处评估的 `func` 的雅可比”乘以 `tangents` 的元组。
`linearize`	返回 `func` 在 `primals` 处的值以及在 `primals` 处的线性近似值。
`jacrev`	使用反向模式自动微分计算 `func` 相对于索引为 `argnum` 的参数的雅可比。
`jacfwd`	使用前向模式自动微分计算 `func` 相对于索引为 `argnum` 的参数的雅可比。
`hessian`	通过前向-反向策略计算 `func` 相对于索引为 `argnum` 的参数的 Hessian。
`functionalize`	functionalize 是一种变换，可用于从函数中删除（中间）变异和别名，同时保留函数的语义。

与 torch.nn.Modules 一起使用的实用程序¶

通常，您可以对调用 torch.nn.Module 的函数进行变换。例如，以下是在计算接受三个值并返回三个值的函数的雅可比的示例。

model = torch.nn.Linear(3, 3)

def f(x):
    return model(x)

x = torch.randn(3)
jacobian = jacrev(f)(x)
assert jacobian.shape == (3, 3)

但是，如果您想做一些像计算模型参数的雅可比这样的事情，则需要有一种方法来构造一个函数，其中参数是函数的输入。这就是 functional_call() 的作用：它接受一个 nn.Module、转换后的 parameters 以及 Module 前向传递的输入。它返回使用替换参数运行 Module 前向传递的值。

以下是我们在参数上计算雅可比的方法。

model = torch.nn.Linear(3, 3)

def f(params, x):
    return torch.func.functional_call(model, params, x)

x = torch.randn(3)
jacobian = jacrev(f)(dict(model.named_parameters()), x)