如何写新的C++ OP

    • : Operator(简写，Op)基类。

    • framework::OpKernel: Op计算函数的基类，称作Kernel。

    • framework::OperatorWithKernel：继承自OperatorBase，Op有计算函数，称作有Kernel。

    • framework::OpProtoAndCheckerMaker：描述该Op的输入、输出、属性、注释，主要用于Python API接口生成。

    根据是否包含Kernel，可以将Op分为两种：包含Kernel的Op和不包含kernel的Op：

    • 包含Kernel的Op继承自OperatorWithKernel，这类Op的功能实现与输入的数据类型、数据布局、数据所在的设备以及Op实现所调用第三方库等有关。比如ConvOp，如果使用CPU计算，一般通过调用mkl库中的矩阵乘操作实现，如果使用GPU计算，一般通过调用cublas库中的矩阵乘操作实现，或者直接调用cudnn库中的卷积操作。

    • 不包含Kernel的Op继承自OperatorBase，因为这类Op的功能实现与设备以及输入的数据不相关。比如WhileOp、IfElseOp等。

    本教程主要介绍带Kernel的Op如何写，简单总结Op需要包含的内容如下：

    实现新的op都添加至目录下，文件命名以*_op.h（如有）、*_op.cc 、*_op.cu（如有）结尾。系统会根据文件名自动构建op和其对应的Python扩展。

    下面以矩阵乘操作，即MulOp为例来介绍如何写带Kernel的Operator。

    矩阵乘法的公式：Out\=X∗YOut\=X∗Y, 可见该计算由两个输入，一个输出组成。

    首先定义ProtoMaker来描述该Op的输入、输出，并添加注释：

    继承自framework::OpProtoAndCheckerMaker。

    开发者通过覆盖framework::OpProtoAndCheckerMaker中的Make函数来定义Op所对应的Proto，通过AddInput添加输入参数，通过AddOutput添加输出参数，通过AddAttr添加属性参数，通过AddComment添加Op的注释。这些函数会将对应内容添加到OpProto中。

    上面的代码在MulOp中添加两个输入X和Y，添加了一个输出Out，以及use_mkldnn等属性，并解释了各自含义，命名请遵守命名规范。

    定义GradOpMaker类

    通常情况下，大部分Op只有一个对应的反向Op，每个Op的会有一个对应的GradOpMaker。为方便代码编写，paddle为只有一个反向的Op提供了一个模板类。MulOp的GradOpMaker需要继承这个模板类，并在Apply()方法中设置反向Op的输入、输出和属性。此外，paddle还提供了一个默认的GradOpMaker， DefaultGradOpMaker，该模板类会使用前向Op的全部输入(Input)输出(Output)以及输出变量所对应的梯度（Output@Grad）作为反向Op的输入，将前向Op的输入变量所对应的的梯度（Input@Grad）作为输出。

    注意: 不要将反向Op不会用到的变量放到反向Op的输入列表中，这样会导致这些不会被反向Op用到的变量的空间不能够及时回收，进而有可能导致用到该Op的模型可以设置的batch_size较低。 比如relu操作的前向操作为：out.device(d) = x.cwiseMax(static_cast<T>(0));反向操作为：dx.device(d) = dout * (out > static_cast<T>(0)).template cast<T>();。显然，反向操作中只是用到了out、dout、dx，没有用到x。因此，通常不建议使用默认的DefaultGradOpMaker。

    下面示例定义了MulOp的GradOpMaker。

    1. template <typename T>
    2. class MulOpGradMaker : public framework::SingleGradOpMaker<T> {
    3.  public:
    4.   using framework::SingleGradOpMaker<T>::SingleGradOpMaker;
    6.  protected:
    7.   void Apply(GradOpPtr<T> retv) const override {
    8.     retv->SetType("mul_grad");
    9.     retv->SetInput("X", this->Input("X"));
    10.     retv->SetInput("Y", this->Input("Y"));
    11.     retv->SetInput(framework::GradVarName("Out"), this->OutputGrad("Out"));
    12.     retv->SetOutput(framework::GradVarName("X"), this->InputGrad("X"));
    13.     retv->SetOutput(framework::GradVarName("Y"), this->InputGrad("Y"));
    14.     retv->SetAttrMap(this->Attrs());
    15.   }
    16. };

    注意：

    • 有些Op的前向逻辑和反向逻辑是一样的，比如.这种情况下，前向Op和反向Op的Kernel可以为同一个。

    • 有些前向Op所对应的反向Op可能有多个，比如SumOp，这种情况下，GradMaker需要继承framework::GradOpDescMakerBase。

    • 有些Op的反向对应另一个Op的前向，比如，这种情况下，SplitGradMaker中定义的SplitOp反向Op的Type就是concat，

    • 为高效地同时支持命令式编程模式(动态图)和声明式编程模式(静态图)，SingleGradOpMaker是一个模板类，在注册Operator时需要同时注册MulOpGradMaker<OpDesc>（声明式编程模式使用）和MulOpGradMaker<OpBase>（命令式编程模式使用）。

    定义Operator类

    下面实现了MulOp的定义：

    1. class MulOp : public framework::OperatorWithKernel {
    2.  public:
    3.   using framework::OperatorWithKernel::OperatorWithKernel;
    5.   void InferShape(framework::InferShapeContext* ctx) const override {
    6.     PADDLE_ENFORCE_EQ(
    7.         ctx->HasInput("X"), true,
    8.         platform::errors::NotFound("Input(X) of MulOp should not be null."));
    9.     PADDLE_ENFORCE_EQ(
    10.         ctx->HasInput("Y"), true,
    11.         platform::errors::NotFound("Input(Y) of MulOp should not be null."));
    12.     PADDLE_ENFORCE_EQ(
    13.         ctx->HasOutput("Out"), true,
    14.         platform::errors::NotFound("Output(Out) of MulOp should not be null."));
    16.     auto x_dims = ctx->GetInputDim("X");
    17.     auto y_dims = ctx->GetInputDim("Y");
    19.     int x_num_col_dims = ctx->Attrs().Get<int>("x_num_col_dims");
    20.     int y_num_col_dims = ctx->Attrs().Get<int>("y_num_col_dims");
    22.     VLOG(3) << "mul operator x.shape=" << x_dims << " y.shape=" << y_dims
    23.             << " x_num_col_dims=" << x_num_col_dims
    24.             << " y_num_col_dims=" << y_num_col_dims;
    26.     PADDLE_ENFORCE_NE(framework::product(y_dims), 0,
    27.                       platform::errors::PreconditionNotMet(
    28.                           "The Input variable Y(%s) has not "
    29.                           "been initialized. You may need to confirm "
    30.                           "if you put exe.run(startup_program) "
    31.                           "after optimizer.minimize function.",
    32.                           ctx->Inputs("Y").front()));
    33.     PADDLE_ENFORCE_GT(
    34.         x_dims.size(), x_num_col_dims,
    35.         platform::errors::InvalidArgument(
    36.             "The input tensor X's dimensions of MulOp "
    37.             "should be larger than x_num_col_dims. But received X's "
    38.             "dimensions = %d, X's shape = [%s], x_num_col_dims = %d.",
    39.             x_dims.size(), x_dims, x_num_col_dims));
    40.     PADDLE_ENFORCE_GT(
    41.         y_dims.size(), y_num_col_dims,
    42.         platform::errors::InvalidArgument(
    43.             "The input tensor Y's dimensions of MulOp "
    44.             "should be larger than y_num_col_dims. But received Y's "
    45.             "dimensions = %d, Y's shape = [%s], y_num_col_dims = %d.",
    46.             y_dims.size(), y_dims, y_num_col_dims));
    48.     auto x_mat_dims = framework::flatten_to_2d(x_dims, x_num_col_dims);
    49.     auto y_mat_dims = framework::flatten_to_2d(y_dims, y_num_col_dims);
    51.     PADDLE_ENFORCE_EQ(
    52.         x_mat_dims[1], y_mat_dims[0],
    53.         platform::errors::InvalidArgument(
    54.             "After flatten the input tensor X and Y to 2-D dimensions "
    55.             "matrix X1 and Y1, the matrix X1's width must be equal with matrix "
    56.             "Y1's height. But received X's shape = [%s], X1's shape = [%s], "
    57.             "X1's "
    58.             "width = %s; Y's shape = [%s], Y1's shape = [%s], Y1's height = "
    59.             "%s.",
    60.             x_dims, x_mat_dims, x_mat_dims[1], y_dims, y_mat_dims,
    61.             y_mat_dims[0]));
    62.     std::vector<int64_t> output_dims;
    63.     output_dims.reserve(
    64.         static_cast<size_t>(x_num_col_dims + y_dims.size() - y_num_col_dims));
    66.     for (int i = 0; i < x_num_col_dims; ++i) {
    67.     }
    69.     for (int i = y_num_col_dims; i < y_dims.size(); ++i) {
    70.       output_dims.push_back(y_dims[i]);
    71.     }
    73.     ctx->SetOutputDim("Out", framework::make_ddim(output_dims));
    74.     ctx->ShareLoD("X", /*->*/ "Out");
    75.   }
    77.   framework::OpKernelType GetExpectedKernelType(
    78.       const framework::ExecutionContext& ctx) const {
    80.     framework::DataLayout layout = framework::DataLayout::kAnyLayout;
    81.     int customized_type_value =
    82.         framework::OpKernelType::kDefaultCustomizedTypeValue;
    83.     auto input_data_type = OperatorWithKernel::IndicateVarDataType(ctx, "X");
    84. #ifdef PADDLE_WITH_MKLDNN
    85.     if (library == framework::LibraryType::kPlain &&
    86.         platform::CanMKLDNNBeUsed(ctx)) {
    87.       library = framework::LibraryType::kMKLDNN;
    88.       layout = framework::DataLayout::kMKLDNN;
    90.       if (input_data_type == framework::DataTypeTrait<int8_t>::DataType() ||
    91.           input_data_type == framework::DataTypeTrait<uint8_t>::DataType()) {
    92.         customized_type_value = kMULMKLDNNINT8;
    93.       }
    94.     }
    95. #endif
    97.     return framework::OpKernelType(input_data_type, ctx.GetPlace(), layout,
    98.                                    library, customized_type_value);
    99.   }
    100. };

    继承自OperatorWithKernel。public成员：

    1. using framework::OperatorWithKernel::OperatorWithKernel;

    这句表示使用基类OperatorWithKernel的构造函数，也可写成：

    1. MulOp(const std::string &type, const framework::VariableNameMap &inputs,
    2.       const framework::VariableNameMap &outputs,
    3.       const framework::AttributeMap &attrs)
    4.   : OperatorWithKernel(type, inputs, outputs, attrs) {}

    此外，Operator类通常需要重写InferShape接口，并在有必要时重写GetExpectedKernelType接口。InferShape为const函数，不能修改Op的成员变量，参数为framework::InferShapeContext* ctx，通过该参数可获取到输入输出以及属性。它的功能是：

    • 做检查， 尽早报错：检查输入数据维度、类型等是否合法。

    • 设置输出Tensor的形状以及LoD信息。

    GetExpectedKernelType接口OperatorWithKernel类中用于获取指定设备（例如CPU，GPU）上指定数据类型（例如double，float）的OpKernel的方法。该方法的重写可见请参考写C++ OP相关注意事项。

    通常OpProtoMaker和Op类的定义写在.cc文件中，和下面将要介绍的注册函数一起放在.cc中

    InferShape区分 compile time 和 run time

    在我们的声明式编程模式网络中，InferShape操作在都会被调用，在compile time时，由于真实的维度未知，框架内部用-1来表示，在run time时，用实际的维度表示，因此维度的值在compile time和 run time时可能不一致，如果存在维度的判断和运算操作，InferShape就需要区分compile time 和 run time。

    以下两种情况需要区分compile time和 run time。

    1.检查

    如以下代码：

    1. auto x_dim = ctx->GetInputDim("X");
    2. int i = xxx;
    3. PADDLE_ENFORCE_GT( x_dim[i] , 10)

    在compile time的时候，x_dim[i]可能等于-1，导致这个PADDLE_ENFORCE_GT报错退出。

    如果用了以下paddle中定义的宏进行判断：

    1. PADDLE_ENFORCE_EQ ( x_dim[i] , 10)
    2. PADDLE_ENFORCE_NE ( x_dim[i] , 10)
    3. PADDLE_ENFORCE_GT ( x_dim[i] , 10)
    4. PADDLE_ENFORCE_GE ( x_dim[i] , 10)
    5. PADDLE_ENFORCE_LT ( x_dim[i] , 10)
    6. PADDLE_ENFORCE_LE ( x_dim[i] , 10)

    都需要区分compile time和run time

    如以下代码:

    1. auto x_dim = ctx->GetInputDim("X");
    2. int i = xxx;
    3. y_dim[0] = x_dim[i] + 10

    在compile time的时候，x_dim[i]可能等于-1，得到的 y_dim[0] 等于 9，是不符合逻辑的

    如果用到了类似以下的运算操作

    1. y_dim[i] = x_dim[i] + 10
    2. y_dim[i] = x_dim[i] - 10
    3. y_dim[i] = x_dim[i] * 10
    4. y_dim[i] = x_dim[i] / 10
    5. y_dim[i] = x_dim[i] + z_dim[i]

    都需要区分compile time和run time

    处理的标准：

    • 检查： compile time的时候不判断维度等于-1的情况，但在runtime的时候检查

    • 运算： -1和其他数做任何运算都要等于-1

    参考代码

    1. 判断的实现方法可以参考cross_entropy_op，cross_entropy_op 要求X和labels的两个输入，除了最后一维以外，其他的维度完全一致
    1. 运算的实现可以参考，concat在InferShape判断时，调用ComputeAndCheckShape，除了进行concat轴之外，其他的维度完全一致；在生成output的维度时，把concat轴的维度求和，其他的维度和输入保持一致。
    1.     const size_t n = inputs_dims.size();
    2.     auto out_dims = inputs_dims[0];
    3.     size_t in_zero_dims_size = out_dims.size();
    4.     for (size_t i = 1; i < n; i++) {
    5.       for (size_t j = 0; j < in_zero_dims_size; j++) {
    6.         if (j == axis) {
    7.           if (is_runtime) {
    8.             out_dims[axis] += inputs_dims[i][j];
    9.           } else {
    10.             if (inputs_dims[i][j] == -1) {
    11.               out_dims[axis] = -1;
    12.             } else {
    13.               out_dims[axis] += inputs_dims[i][j];
    14.             }
    15.           }
    16.         } else {
    17.           bool check_shape =
    18.               is_runtime || (out_dims[j] > 0 && inputs_dims[i][j] > 0);
    19.           if (check_shape) {
    20.             // check all shape in run time
    21.             PADDLE_ENFORCE_EQ(
    22.                 inputs_dims[0][j], inputs_dims[i][j],
    23.                 "ShapeError: Dimension %d in inputs' shapes must be equal. "
    24.                 "But recevied input[0]'s shape = "
    25.                 "[%s], input[%d]'s shape = [%s].",
    26.                 j, inputs_dims[0], i, inputs_dims[i]);
    27.           }
    28.         }
    29.       }
    30.     }

    MulKernel继承自framework::OpKernel，带有下面两个模板参数:

    • typename DeviceContext: 表示设备类型。不同设备(CPU、CUDA)共享同一个Kernel时，需加该模板参数；不共享则不加，一个不共享的例子是SGDOpKernel。

    • typename T : 表示数据类型，如float, double, int16等。

    需要为MulKernel类重写Compute接口。

    • Compute接受一个输入参数：const framework::ExecutionContext& context。

    • 与InferShapeContext相比，ExecutionContext增加了设备类型，同样可获取到输入输出和属性参数。

    • Compute函数里实现OpKernel的具体计算逻辑。

    Op的输入和输出可分别通过ExecutionContext::Input<T>()和ExecutionContext::Output<T>()获得。

    注意： 若op的输入/输出的变量类型是LoDTensor（paddle默认所有的Tensor默认都是LoDTensor类型），请写成ExecutionContext::Input<LoDTensor>()和ExecutionContext::Output<LoDTensor>()，不要写ExecutionContext::Input<Tensor>()和ExecutionContext::Output<Tensor>()。因为若实际的变量类型为SelectedRows，Input<Tensor>()和Output<Tensor>()方法会将SelectedRows类型特化为Tensor，导致潜在的错误。

    下面是 MulKernel Compute的实现：

    1. template <typename DeviceContext, typename T>
    2. class MulKernel : public framework::OpKernel<T> {
    3.  public:
    4.   void Compute(const framework::ExecutionContext& context) const override {
    5.     const Tensor* x = context.Input<Tensor>("X");
    6.     const Tensor* y = context.Input<Tensor>("Y");
    7.     Tensor* z = context.Output<Tensor>("Out");
    8.     const Tensor x_matrix =
    9.         x->dims().size() > 2
    10.             ? framework::ReshapeToMatrix(
    11.                   *x, context.template Attr<int>("x_num_col_dims"))
    12.             : *x;
    13.     const Tensor y_matrix =
    14.         y->dims().size() > 2
    15.             ? framework::ReshapeToMatrix(
    16.                   *y, context.template Attr<int>("y_num_col_dims"))
    18.     z->mutable_data<T>(context.GetPlace());
    19.     auto z_dim = z->dims();
    20.     if (z_dim.size() != 2) {
    21.       z->Resize({x_matrix.dims()[0], y_matrix.dims()[1]});
    22.     }
    24.     auto blas = math::GetBlas<DeviceContext, T>(context);
    26.     blas.MatMul(x_matrix, y_matrix, z);
    27.     if (z_dim.size() != 2) {
    28.       z->Resize(z_dim);
    29.     }
    31. };

    需要注意：不同设备(CPU、CUDA)共享一个Op定义，是否则共享同一个OpKernel，取决于Compute调用的函数是否支持不同设备。

    MulOp的CPU、CUDA实现共享同一个Kernel。OpKernel不共享的例子可以参考：。

    为了使OpKernel的计算过程书写更加简单，并且CPU、CUDA的代码可以复用，我们通常借助 Eigen unsupported Tensor模块来实现Compute接口。关于在PaddlePaddle中如何使用Eigen库，请参考使用文档。

    到此，前向Op实现完成。接下来，需要在.cc文件中注册该op和kernel。 反向Op类的定义，反向OpKernel的定义与前向Op类似，这里不再赘述。

    注册Operator

    • 在.cc文件中注册前向、反向Op类，注册CPU Kernel。

      1. namespace ops = paddle::operators;
      2. REGISTER_OPERATOR(mul, ops::MulOp, ops::MulOpMaker, ops::MulOpInferVarType,
      3.                   ops::MulOpGradMaker<paddle::framework::OpDesc>,
      4.                   ops::MulOpGradMaker<paddle::imperative::OpBase>);
      6. REGISTER_OPERATOR(mul_grad, ops::MulGradOp);
      8. REGISTER_OP_CPU_KERNEL(mul,
      9.               ops::MulKernel<paddle::platform::CPUDeviceContext, float>,
      10.               ops::MulKernel<paddle::platform::CPUDeviceContext, double>);
      11. REGISTER_OP_CPU_KERNEL(mul_grad,
      12.               ops::MulGradKernel<paddle::platform::CPUDeviceContext, float>,
      13.               ops::MulGradKernel<paddle::platform::CPUDeviceContext, double>);

      在上面的代码中，使用REGISTER_OPERATOR注册了ops::MulOp类，类型名为mul，该类的ProtoMaker为ops::MulOpMaker，其GradOpMaker分别是ops::MulOpGradMaker<paddle::framework::OpDesc>（声明式编程模式使用）和ops::MulOpGradMaker<paddle::imperative::OpBase>(命令式编程模式使用)，并使用REGISTER_OPERATOR注册ops::MulGradOp，类型名为mul_grad。然后，使用REGISTER_OP_CPU_KERNEL注册了ops::MulKernel类，并特化模板参数为设备为paddle::platform::CPUPlace、数据类型为float类型和double类型；同理，注册ops::MulGradKernel类。

    • 在 .cu文件中注册CUDA Kernel。

      • 请注意，如果CUDA Kernel的实现基于Eigen unsupported模块，那么在 .cu的开始请加上宏定义 #define EIGEN_USE_GPU，代码示例如下：
      1. // if use Eigen unsupported module before include head files
      2. #define EIGEN_USE_GPU
      4. namespace ops = paddle::operators;
      5. REGISTER_OP_CUDA_KERNEL(mul,
      6.                         ops::MulKernel<paddle::platform::CUDADeviceContext, float>,
      7.                         ops::MulKernel<paddle::platform::CUDADeviceContext, double>);
      8. REGISTER_OP_CUDA_KERNEL(mul_grad,
      9.                         ops::MulGradKernel<paddle::platform::CUDADeviceContext, float>,
      10.                         ops::MulGradKernel<paddle::platform::CUDADeviceContext, double>);

    注意：

    在运行Op时，框架系统会根据输入数据所在的设备、输入数据的类型等信息自动的选择合适的OpKernel，比如输入的数据是在GPU上，并且为float类型，框架系统会选择由REGISTER_OP_CUDA_KERNEL注册的ops::MulKernel<paddle::platform::CUDADeviceContext, float>。如果用户希望指定运行时可被调用的OpKernel，用户需要覆盖framework::OperatorWithKernel中的GetExpectedKernelType函数，比如MulOp会根据属性use_mkldnn为false还是为true决定是否调用mkldnn库来完成计算。

    编译

    详细的编译环境准备和执行流程可参考，下面简单介绍几个主要步骤。 在Paddle代码目录下创建并切换到build目录：

    1. mkdir build && cd build

    执行cmake命令，具体选项可参考从源码编译中的介绍，下面的命令为编译Python3.5，GPU版本，带测试，Release版本的Paddle。

    1. cmake .. -DPY_VERSION=3.5 -DWITH_GPU=ON -DWITH_TESTING=ON -DCMAKE_BUILD_TYPE=Release

    在build目录下，运行下面命令可以进行编译整个paddle：

    1. make -j$(nproc)

    注意： 新增op后请重新执行cmake命令，然后再执行make命令编译paddle。

    系统会对新增的op自动绑定Python，并链接到生成的lib库中。

    使用mul操作在Python端构建Layer

    在Python端，mul操作用于构建FC层，即：

    Out\=Act(X∗W+b)Out\=Act(X∗W+b)

    具体实现方式可参考。

    单测包括对比前向Op不同设备(CPU、CUDA)的实现、对比反向OP不同设备(CPU、CUDA)的实现、反向Op的梯度测试。下面介绍介绍MulOp的单元测试。

    注意：

    单测中的测试用例需要尽可能的覆盖Op中的所有分支。

    1. 在setUp函数定义输入、输出，以及相关的属性参数。

    2. 生成随机的输入数据。

    3. 在Python脚本中实现与前向operator相同的计算逻辑，得到输出值，与operator前向计算的输出进行对比。

    4. 反向计算已经自动集成进测试框架，直接调用相应接口即可。

      ``` import unittest import numpy as np from op_test import OpTest

    1. class TestMulOp(OpTest):
    2.     def setUp(self):
    3.         self.op_type = "mul"
    4.         self.inputs = {
    5.             'X': np.random.random((32, 84)).astype("float32"),
    6.             'Y': np.random.random((84, 100)).astype("float32")
    7.         }
    8.         self.outputs = {'Out': np.dot(self.inputs['X'], self.inputs['Y'])}
    10.     def test_check_output(self):
    11.         self.check_output()
    13.     def test_check_grad_normal(self):
    14.         self.check_grad(['X', 'Y'], 'Out', max_relative_error=0.5)
    16.     def test_check_grad_ingore_x(self):
    17.         self.check_grad(
    18.             ['Y'], 'Out', max_relative_error=0.5, no_grad_set=set("X"))
    20.     def test_check_grad_ingore_y(self):
    21.         self.check_grad(
    22.             ['X'], 'Out', max_relative_error=0.5, no_grad_set=set('Y'))
    23. ```
    25. 上面的代码首先导入依赖的包，下面是对`setUp`函数中操作的重要变量的详细解释：
    27. -   `self.op_type = "mul"` : 定义类型，与operator注册时注册的类型一致。
    29. -   `self.inputs` : 定义输入，类型为`numpy.array`，并初始化。
    31. -   `self.outputs` : 定义输出，并在Python脚本中完成与operator同样的计算逻辑，返回Python端的计算结果。

    反向operator单测

    而反向测试中：

    • test_check_grad_normal中调用check_grad使用数值法检测梯度正确性和稳定性。

      • 第一个参数["X", "Y"] : 指定对输入变量X、Y做梯度检测。

      • 第二个参数"Out" : 指定前向网络最终的输出目标变量Out。

      • 第三个参数max_relative_error：指定检测梯度时能容忍的最大错误值。

    • test_check_grad_ingore_x和test_check_grad_ingore_y分支用来测试只需要计算一个输入梯度的情况。

    编译和执行

    python/paddle/fluid/tests/unittests/ 目录下新增的 test_*.py 单元测试会被自动加入工程进行编译。

    请注意，运行单元测试测时需要编译整个工程，并且编译时需要打开WITH_TESTING。

    参考上述过程，编译成功后，在build目录下执行下面的命令来运行单元测试：

    或者执行:

    1. ctest -R test_mul_op

    • 注册Op时的类型名，需要和该Op的名字一样。即不允许在A_op.cc里面，注册REGISTER_OPERATOR(B, ...)等，这将会导致单元测试出错。

    • 如果Op没有实现CUDA Kernel，请不要创建空的*_op.cu，这将会导致单元测试出错。

    • 如果多个Op依赖一些共用的函数，可以创建非*_op.*格式的文件来存放，如gather.h文件。

    PADDLE_ENFORCE使用注意

    实现Op时检查数据的合法性需要使用PADDLE_ENFORCE以及PADDLE_ENFORCE_EQ等宏定义，基本格式如下：

    1. PADDLE_ENFORCE(表达式, 错误提示信息)
    2. PADDLE_ENFORCE_EQ(比较对象A, 比较对象B, 错误提示信息)

    如果表达式为真，或者比较对象A=B，则检查通过，否则会终止程序运行，向用户反馈相应的错误提示信息。 为了确保提示友好易懂，开发者需要注意其使用方法。

    总体原则

    任何使用了PADDLE_ENFORCE与PADDLE_ENFORCE_XX检查的地方，必须有详略得当的备注解释！错误提示信息不能为空！

    提示信息书写标准

    1. [required] 哪里错了？为什么错了？

      • 例如：ValueError: Mismatched label shape

    2. [optional] 期望的输入是什么样的？实际的输入是怎样的？

      • 例如：Expected labels dimension=1. Received 4.

    3. [optional] 能否给出修改意见？

      • 例如：Suggested Fix:If your classifier expects one-hot encoding label,check your n_classes argument to the estimatorand/or the shape of your label.Otherwise, check the shape of your label.

    如果并非必要或者简洁的描述即可表达清楚以上要点，根据情况书写亦可。

    FAQ 典型问题

    1. 无报错信息或报错信息过于简单，不能给用户提供有效的提示！

      问题示例1 ：未写提示信息

      1. PADDLE_ENFORCE(ctx->HasInput("X"), "");

      问题示例2 ：提示信息过于简单

      1. PADDLE_ENFORCE(i != nullptr, "i must be set"); // i是什么？

    2. 在报错信息中使用开发人员定义的变量缩写，不易理解！

      问题示例：

      1. PADDLE_ENFORCE(forward_pd != nullptr,
      2.                     "Fail to find eltwise_fwd_pd in device context");  //eltwise_fwd_pd用户可能看不懂

    3. OP内部调用非法接口：Op内部如果出现Output = ShareDataWith(Input) 问题示例：

      1. auto *out = ctx.Output<framework::LoDTensor>("Out");
      2. auto *in = ctx.Input<framework::LoDTensor>("X");
      3. out->ShareDataWith(*in);

      Op内部如果出现Output = ShareDataWith(Input)，相当于operator图的中有一条隐藏边，连接了Input和Output，这条边无法在图分析中表达，引发基于图优化的错误。

    4. OP实现的性能实践 调用了eigen的broadcast, chop等操作，性能会比手写cuda kernel差几倍以上。此时cpu的实现可以复用eigen，gpu实现可以实现cuda kernel.

    OP InferShape检查提示信息特别说明

    • 检查输入输出变量，请统一遵循以下格式 Input(变量名) of OP名 operator should not be null.

      正确示例：

      1. PADDLE_ENFORCE(ctx->HasInput("Input"),
      2.                         "Input(Input) of LSTMP operator should not be null.");

    • 反向Op的输入输出检查，要写明反向Op的名字

      正确示例：

      1. PADDLE_ENFORCE(ctx->HasInput("X"),
      2.                         "Input(X) of LoDResetGrad opreator should not be null.");