py_func

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

  • paddle.fluid.layers.py_func(func, x, out, backward_func=None, skip_vars_in_backward_input=None)[源代码]

PaddlePaddle Fluid通过py_func在Python端注册OP。py_func的设计原理在于Paddle中的LodTensor与numpy数组可以方便的互相转换，从而可使用Python中的numpy API来自定义一个Python OP。

该自定义的Python OP的前向函数是 func, 反向函数是 backward_func 。 Paddle将在前向部分调用 func ，并在反向部分调用 backward_func （如果 backward_func 不是None)。 x 为 func 的输入，必须为LoDTensor类型； out 为 func 的输出， 既可以是LoDTensor类型, 也可以是numpy数组。

反向函数 backward_func 的输入依次为：前向输入 x 、前向输出 out 、 out 的梯度。 如果 out 的某些变量没有梯度，则 backward_func 的相关输入变量为None。如果 x 的某些变量没有梯度，则用户应在 backward_func 中主动返回None。

在调用该接口之前，还应正确设置 out 的数据类型和形状，而 out 和 x 对应梯度的数据类型和形状将自动推断而出。

此功能还可用于调试正在运行的网络，可以通过添加没有输出的 py_func 运算，并在 func 中打印输入 x 。

  • 参数:
    • func （callable） - 所注册的Python OP的前向函数，运行网络时，将根据该函数与前向输入 x ，计算前向输出 out 。 在 func 建议先主动将LoDTensor转换为numpy数组，方便灵活的使用numpy相关的操作，如果未转换成numpy，则可能某些操作无法兼容。
    • x (Variable|tuple(Variable)|list[Variale]) - 前向函数 func 的输入，多个LoDTensor以tuple(Variable)或list[Variale]的形式传入，其中Variable为LoDTensor或Tenosr。
    • out (Variable|tuple(Variable)|list[Variale]) - 前向函数 func 的输出，可以为Variable|tuple(Variable)|list[Variale]，其中Variable既可以为LoDTensor或Tensor，也可以为numpy数组。由于Paddle无法自动推断 out 的形状和数据类型，必须应事先创建 out 。
    • backward_func (callable，可选) - 所注册的Python OP的反向函数。默认值为None，意味着没有反向计算。若不为None，则会在运行网络反向时调用 backward_func 计算 x 的梯度。
    • skip_vars_in_backward_input (Variable，可选) - backward_func 的输入中不需要的变量，可以是Variable|tuple(Variable)|list[Variale]。 这些变量必须是 x 和 out 中的一个。默认值为None，意味着没有变量需要从 x 和 out 中去除。若不为None，则这些变量将不是 backward_func 的输入。该参数仅在 backward_func 不为None时有用。

返回: 前向函数的输出 out

返回类型: Variable|tuple(Variable)|list[Variable]

示例代码1:

  1. import paddle.fluid as fluid
  2. import six
  3.  
  4. # 自定义的前向函数，可直接输入LoDTenosor
  5. def tanh(x):
  6.     return np.tanh(x)
  7.  
  8. # 在反向函数中跳过前向输入x，返回x的梯度。
  9. # 必须使用np.array主动将LodTensor转换为numpy，否则"+/-"等操作无法使用
  10. def tanh_grad(y, dy):
  11.     return np.array(dy) * (1 - np.square(np.array(y)))
  12.  
  13. # 自定义的前向函数，可用于调试正在运行的网络（打印值）
  14. def debug_func(x):
  15.     print(x)
  16.  
  17. def create_tmp_var(name, dtype, shape):
  18.     return fluid.default_main_program().current_block().create_var(
  19.         name=name, dtype=dtype, shape=shape)
  20.  
  21. def simple_net(img, label):
  22.     hidden = img
  23.     for idx in six.moves.range(4):
  24.         hidden = fluid.layers.fc(hidden, size=200)
  25.         new_hidden = create_tmp_var(name='hidden_{}'.format(idx),
  26.             dtype=hidden.dtype, shape=hidden.shape)
  27.  
  28.         # 用户自定义的前向反向计算
  29.         hidden = fluid.layers.py_func(func=tanh, x=hidden,
  30.             out=new_hidden, backward_func=tanh_grad,
  31.             skip_vars_in_backward_input=hidden)
  32.  
  33.         # 用户自定义的调试函数，打印出输入的LodTensor
  34.         fluid.layers.py_func(func=debug_func, x=hidden, out=None)
  35.  
  36.     prediction = fluid.layers.fc(hidden, size=10, act='softmax')
  37.     loss = fluid.layers.cross_entropy(input=prediction, label=label)
  38.     return fluid.layers.mean(loss)

示例代码2:

  1. # 该示例展示了如何将LoDTensor转化为numpy数组，并利用numpy API来自定义一个OP
  2. import paddle.fluid as fluid
  3. import numpy as np
  4.  
  5. def element_wise_add(x, y):
  6.     # 必须先手动将LodTensor转换为numpy数组，否则无法支持numpy的shape操作
  7.     x = np.array(x)
  8.     y = np.array(y)
  9.  
  10.     if x.shape != y.shape:
  11.         raise AssertionError("the shape of inputs must be the same!")
  12.  
  13.     result = np.zeros(x.shape, dtype='int32')
  14.     for i in range(len(x)):
  15.         for j in range(len(x[0])):
  16.             result[i][j] = x[i][j] + y[i][j]
  17.  
  18.     return result
  19.  
  20. def create_tmp_var(name, dtype, shape):
  21.     return fluid.default_main_program().current_block().create_var(
  22.                 name=name, dtype=dtype, shape=shape)
  23.  
  24. def py_func_demo():
  25.     start_program = fluid.default_startup_program()
  26.     main_program = fluid.default_main_program()
  27.  
  28.     # 创建前向函数的输入变量
  29.     x = fluid.data(name='x', shape=[2,3], dtype='int32')
  30.     y = fluid.data(name='y', shape=[2,3], dtype='int32')
  31.  
  32.     # 创建前向函数的输出变量，必须指明变量名称name/数据类型dtype/维度shape
  33.     output = create_tmp_var('output','int32', [3,1])
  34.  
  35.     # 输入多个LodTensor以list[Variable]或tuple(Variable)形式
  36.     fluid.layers.py_func(func=element_wise_add, x=[x,y], out=output)
  37.  
  38.     exe=fluid.Executor(fluid.CPUPlace())
  39.     exe.run(start_program)
  40.  
  41.     # 给program喂入numpy数组
  42.     input1 = np.random.randint(1, 10, size=[2,3], dtype='int32')
  43.     input2 = np.random.randint(1, 10, size=[2,3], dtype='int32')
  44.     out = exe.run(main_program,
  45.                 feed={'x':input1, 'y':input2},
  46.                 fetch_list=[output.name])
  47.     print("{0} + {1} = {2}".format(input1, input2, out))
  48.  
  49. py_func_demo()
  50.  
  51. # 参考输出：
  52. # [[5, 9, 9]   + [[7, 8, 4]  =  [array([[12, 17, 13]
  53. #  [7, 5, 2]]     [1, 3, 3]]            [8, 8, 5]], dtype=int32)]