grad

API属性:命令式编程模式(动态图)

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

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

参数

  • outputs (Variable|list(Variable)|tuple(Variable)) – 用于计算梯度的图的输出变量,或多个输出变量构成的list/tuple。
  • inputs (Variable|list(Variable)|tuple(Variable)) - 用于计算梯度的图的输入变量,或多个输入变量构成的list/tuple。该API的每个返回值对应每个 inputs 的梯度。
  • grad_outputs (Variable|list(Variable|None)|tuple(Variable|None), 可选) - outputs 变量梯度的初始值。若 grad_outputs 为None,则 outputs 梯度的初始值均为全1的Tensor。若 grad_outputs 不为None,它必须与 outputs 的长度相等,此时,若 grad_outputs 的第i个元素为None,则第i个 outputs 的梯度初始值为全1的Tensor;若 grad_outputs 的第i个元素为Variable,则第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 (Variable|list(Variable)|tuple(Variable)|set(Variable), 可选) - 指明不需要计算梯度的变量。默认值为None。
  • backward_strategy (BackwardStrategy, 可选) - 计算梯度的策略。详见 BackwardStrategy 。默认值为None。

返回

变量构成的tuple,其长度等于 inputs 中的变量个数,且第i个返回的变量是所有 outputs 相对于第i个 inputs 的梯度之和。

返回类型

tuple

代码示例 1

import paddle.fluid as fluid

def test_dygraph_grad(create_graph):
    with fluid.dygraph.guard():
        x = fluid.layers.ones(shape=[1], dtype='float32')
        x.stop_gradient = False
        y = x * x

        # Since y = x * x, dx = 2 * x
        dx = fluid.dygraph.grad(
                outputs=[y],
                inputs=[x],
                create_graph=create_graph,
                retain_graph=True)[0]

        z = y + dx

        # If create_graph = False, the gradient of dx
        # would not be backpropagated. Therefore,
        # z = x * x + dx, and x.gradient() = 2 * x = 2.0

        # If create_graph = True, the gradient of dx
        # would be backpropagated. Therefore,
        # z = x * x + dx = x * x + 2 * x, and
        # x.gradient() = 2 * x + 2 = 4.0

        z.backward()
        return x.gradient()

print(test_dygraph_grad(create_graph=False)) # [2.]
print(test_dygraph_grad(create_graph=True)) # [4.]

代码示例 2

import paddle.fluid as fluid

fluid.enable_dygraph()

def test_dygraph_grad(grad_outputs=None):
    x = fluid.layers.fill_constant(shape=[1], value=2.0, dtype='float32')
    x.stop_gradient = False

    y1 = x * x
    y2 = x * 3

    # If grad_outputs=None, dy1 = [1], dy2 = [1].
    # If grad_outputs=[g1, g2], then:
    #    - dy1 = [1] if g1 is None else g1
    #    - dy2 = [1] if g2 is None else g2

    # Since y1 = x * x, dx = 2 * x * dy1.
    # Since y2 = x * 3, dx = 3 * dy2.
    # Therefore, the final result would be:
    # dx = 2 * x * dy1 + 3 * dy2 = 4 * dy1 + 3 * dy2.

    dx = fluid.dygraph.grad(
        outputs=[y1, y2],
        inputs=[x],
        grad_outputs=grad_outputs)[0]

    return dx.numpy()

THREE = fluid.layers.fill_constant(shape=[1], value=3.0, dtype='float32')
FOUR = fluid.layers.fill_constant(shape=[1], value=4.0, dtype='float32')

# dy1 = [1], dy2 = [1]
print(test_dygraph_grad(None)) # [7.]

# dy1 = [1], dy2 = [4]
print(test_dygraph_grad([None, FOUR])) # [16.]

# dy1 = [4], dy2 = [1]
print(test_dygraph_grad([FOUR, None])) # [19.]

# dy1 = [3], dy2 = [4]
print(test_dygraph_grad([THREE, FOUR])) # [24.]