torch.autograd.grad

torch.autograd.grad(outputs, inputs, grad_outputs=None, retain_graph=None, create_graph=False, only_inputs=True, allow_unused=None, is_grads_batched=False, materialize_grads=False)

计算并返回输出相对于输入的梯度之和。

grad_outputs 应该是与 output 长度匹配的序列，其中包含向量-雅可比积中的“向量”，通常是预先计算的相对于每个输出的梯度。如果输出不需要梯度，则梯度可以为 None）。

注意

如果您在用户指定的 CUDA 流上下文中运行任何前向操作，创建 grad_outputs，和/或调用 grad，请参阅反向传播的流语义。

注意

only_inputs 参数已弃用，现在已被忽略（默认为 True）。要累积图中其他部分的梯度，请使用 torch.autograd.backward。

参数

• outputs (Tensor 序列 或 GradientEdge 序列) – 可微分函数的输出。

• inputs (Tensor 序列 或 GradientEdge 序列) – 将返回梯度（而不是累积到 .grad 中）的输入。

• grad_outputs (Tensor 序列) – 向量-雅可比积中的“向量”。通常是相对于每个输出的梯度。对于标量张量或不需要梯度的张量，可以指定 None 值。如果所有 grad_tensors 都接受 None 值，则此参数是可选的。默认值：None。

• retain_graph (bool, 可选) – 如果为 False，则用于计算梯度的图将被释放。请注意，在几乎所有情况下，都不需要将此选项设置为 True，并且通常可以用更有效的方式解决。默认为 create_graph 的值。

• create_graph (bool, 可选) – 如果为 True，则将构建导数的图，从而可以计算更高阶的导数乘积。默认值：False。

• allow_unused (Optional[bool], 可选) – 如果为 False，则指定在计算输出时未使用的输入（因此它们的梯度始终为零）是错误的。默认为 materialize_grads 的值。

• is_grads_batched (bool, 可选) – 如果为 True，则 grad_outputs 中每个张量的第一个维度将被解释为批次维度。我们不是计算单个向量-雅可比积，而是为批次中的每个“向量”计算一批向量-雅可比积。我们使用 vmap 原型功能作为后端来向量化对 autograd 引擎的调用，以便可以在单个调用中执行此计算。与手动循环并多次执行反向传播相比，这应该可以提高性能。请注意，由于此功能是实验性的，因此可能存在性能陡坡。请使用 torch._C._debug_only_display_vmap_fallback_warnings(True) 显示任何性能警告，如果您的用例存在警告，请在 github 上提交问题。默认值：False。

• materialize_grads (bool, 可选) – 如果为 True，则将未使用输入的梯度设置为零而不是 None。这在计算高阶导数时很有用。如果 materialize_grads 为 True 且 allow_unused 为 False，则会引发错误。默认值：False。

返回类型

Tuple[Tensor, …]