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)