grad

注意：该API仅支持【动态图】模式

paddle.grad ( outputs, inputs, grad_outputs=None, retain_graph=None, create_graph=False, only_inputs=True, allow_unused=False, no_grad_vars=None ) [源代码]

对于每个 inputs ，计算所有 outputs 相对于其的梯度和。

参数:

  • outputs (Tensor|list(Tensor)|tuple(Tensor)) – 用于计算梯度的图的输出变量，或多个输出变量构成的list/tuple。

  • inputs (Tensor|list(Tensor)|tuple(Tensor)) - 用于计算梯度的图的输入变量，或多个输入变量构成的list/tuple。该API的每个返回值对应每个 inputs 的梯度。

  • grad_outputs (Tensor|list(Tensor|None)|tuple(Tensor|None), 可选) - outputs 变量梯度的初始值。若 grad_outputs 为None，则 outputs 梯度的初始值均为全1的Tensor。若 grad_outputs 不为None，它必须与 outputs 的长度相等，此时，若 grad_outputs 的第i个元素为None，则第i个 outputs 的梯度初始值为全1的Tensor；若 grad_outputs 的第i个元素为Tensor，则第i个 outputs 的梯度初始值为 grad_outputs 的第i个元素。默认值为None。

  • retain_graph (bool, 可选) - 是否保留计算梯度的前向图。若值为True，则前向图会保留，用户可对同一张图求两次反向。若值为False，则前向图会释放。默认值为None，表示值与 create_graph 相等。

  • create_graph (bool, 可选) - 是否创建计算过程中的反向图。若值为True，则可支持计算高阶导数。若值为False，则计算过程中的反向图会释放。默认值为False。

  • only_inputs (bool, 可选) - 是否只计算 inputs 的梯度。若值为False，则图中所有叶节点变量的梯度均会计算，并进行累加。若值为True，则只会计算 inputs 的梯度。默认值为True。only_inputs=False功能正在开发中，目前尚不支持。

  • allow_unused (bool, 可选) - 决定当某些 inputs 变量不在计算图中时抛出错误还是返回None。若某些 inputs 变量不在计算图中（即它们的梯度为None），则当allowed_unused=False时会抛出错误，当allow_unused=True时会返回None作为这些变量的梯度。默认值为False。

  • no_grad_vars (Tensor|list(Tensor)|tuple(Tensor)|set(Tensor), 可选) - 指明不需要计算梯度的变量。默认值为None。

返回: tuple(Tensor)，其长度等于 inputs 中的变量个数，且第i个返回的变量是所有 outputs 相对于第i个 inputs 的梯度之和。

示例代码 1

  1. import paddle
  3. def test_dygraph_grad(create_graph):
  4.     x = paddle.ones(shape=[1], dtype='float32')
  5.     x.stop_gradient = False
  6.     y = x * x
  8.     # Since y = x * x, dx = 2 * x
  9.     dx = paddle.grad(
  10.             outputs=[y],
  11.             inputs=[x],
  12.             create_graph=create_graph,
  13.             retain_graph=True)[0]
  15.     z = y + dx
  17.     # If create_graph = False, the gradient of dx
  18.     # would not be backpropagated. Therefore,
  19.     # z = x * x + dx, and x.gradient() = 2 * x = 2.0
  21.     # If create_graph = True, the gradient of dx
  22.     # would be backpropagated. Therefore,
  23.     # z = x * x + dx = x * x + 2 * x, and
  24.     # x.gradient() = 2 * x + 2 = 4.0
  26.     z.backward()
  27.     return x.gradient()
  29. print(test_dygraph_grad(create_graph=False)) # [2.]
  30. print(test_dygraph_grad(create_graph=True)) # [4.]

示例代码 2

  1. import paddle
  3. def test_dygraph_grad(grad_outputs=None):
  4.     x = paddle.to_tensor(2.0)
  5.     x.stop_gradient = False
  7.     y1 = x * x
  8.     y2 = x * 3
  10.     # If grad_outputs=None, dy1 = [1], dy2 = [1].
  11.     # If grad_outputs=[g1, g2], then:
  12.     #    - dy1 = [1] if g1 is None else g1
  13.     #    - dy2 = [1] if g2 is None else g2
  15.     # Since y1 = x * x, dx = 2 * x * dy1.
  16.     # Since y2 = x * 3, dx = 3 * dy2.
  17.     # Therefore, the final result would be:
  18.     # dx = 2 * x * dy1 + 3 * dy2 = 4 * dy1 + 3 * dy2.
  20.     dx = paddle.grad(
  21.         outputs=[y1, y2],
  22.         inputs=[x],
  23.         grad_outputs=grad_outputs)[0]
  25.     return dx.numpy()
  27. grad_value = paddle.to_tensor(4.0)
  29. # dy1 = [1], dy2 = [1]
  30. print(test_dygraph_grad(None)) # [7.]
  32. # dy1 = [1], dy2 = [4]
  33. print(test_dygraph_grad([None, grad_value])) # [16.]
  35. # dy1 = [4], dy2 = [1]
  36. print(test_dygraph_grad([grad_value, None])) # [19.]
  38. # dy1 = [3], dy2 = [4]
  39. grad_y1 = paddle.to_tensor(3.0)
  40. print(test_dygraph_grad([grad_y1, grad_value])) # [24.]