mul_op.cc 4.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License. */

15
#include "paddle/operators/mul_op.h"
16 17 18 19

namespace paddle {
namespace operators {

D
dongzhihong 已提交
20 21
using framework::Tensor;

D
dongzhihong 已提交
22
class MulOp : public framework::OperatorWithKernel {
Y
Yu Yang 已提交
23 24
 public:
  using framework::OperatorWithKernel::OperatorWithKernel;
25

26
 protected:
D
dongzhihong 已提交
27
  void InferShape(const framework::InferShapeContext &ctx) const override {
28 29
    auto x_dims = ctx.Input<Tensor>("X")->dims();
    auto y_dims = ctx.Input<Tensor>("Y")->dims();
F
fengjiayi 已提交
30 31
    int x_num_col_dims = Attr<int>("x_num_col_dims");
    int y_num_col_dims = Attr<int>("y_num_col_dims");
F
WIP  
fengjiayi 已提交
32

F
fengjiayi 已提交
33
    PADDLE_ENFORCE(x_dims.size() > x_num_col_dims,
F
WIP  
fengjiayi 已提交
34
                   "The rank of input tensor X(%s) should be larger than "
F
fengjiayi 已提交
35
                   "`mul_op`'s `x_num_col_dims`.",
36
                   ctx.op().Input("X"));
F
fengjiayi 已提交
37
    PADDLE_ENFORCE(y_dims.size() > y_num_col_dims,
F
WIP  
fengjiayi 已提交
38
                   "The rank of input tensor Y(%s) should be larger than "
F
fengjiayi 已提交
39
                   "`mul_op`'s `y_num_col_dims`.",
40
                   ctx.op().Input("Y"));
41

F
fengjiayi 已提交
42 43
    auto x_mat_dims = framework::flatten_to_2d(x_dims, x_num_col_dims);
    auto y_mat_dims = framework::flatten_to_2d(y_dims, y_num_col_dims);
44

Y
Yan Chunwei 已提交
45
    PADDLE_ENFORCE_EQ(
46
        x_mat_dims[1], y_mat_dims[0],
47
        "First matrix's width must be equal with second matrix's height.");
48
    ctx.Output<Tensor>("Out")->Resize({x_mat_dims[0], y_mat_dims[1]});
49 50 51
  }
};

D
dongzhihong 已提交
52
class MulOpMaker : public framework::OpProtoAndCheckerMaker {
53
 public:
D
dongzhihong 已提交
54
  MulOpMaker(framework::OpProto *proto, framework::OpAttrChecker *op_checker)
55
      : OpProtoAndCheckerMaker(proto, op_checker) {
56 57 58
    AddInput("X", "The first input of mul op");
    AddInput("Y", "The second input of mul op");
    AddOutput("Out", "The output of mul op");
F
WIP  
fengjiayi 已提交
59
    AddAttr<int>(
F
fengjiayi 已提交
60
        "x_num_col_dims",
F
fengjiayi 已提交
61 62 63 64 65 66
        R"DOC(mul_op can take tensors with more than two dimensions as input `X`, 
            in that case, tensors will be reshaped to a matrix. The matrix's first 
            dimension(column length) will be the product of tensor's last 
            `num_col_dims` dimensions, and the matrix's second dimension(row length)
            will be the product of tensor's first `rank - num_col_dims` dimensions.
        )DOC")
F
WIP  
fengjiayi 已提交
67
        .SetDefault(1)
F
fengjiayi 已提交
68
        .EqualGreaterThan(1);
F
WIP  
fengjiayi 已提交
69
    AddAttr<int>(
F
fengjiayi 已提交
70
        "y_num_col_dims",
F
fengjiayi 已提交
71 72 73
        R"DOC(mul_op can take tensors with more than two dimensions as input `Y`,
             in that case, tensors will be reshaped to a matrix. Just like input `X`.
        )DOC")
F
WIP  
fengjiayi 已提交
74
        .SetDefault(1)
F
fengjiayi 已提交
75
        .EqualGreaterThan(1);
76 77 78 79 80 81 82 83
    AddComment(R"DOC(
Two Element Mul Operator.

The equation is: Out = X * Y
)DOC");
  }
};

D
dongzhihong 已提交
84
class MulOpGrad : public framework::OperatorWithKernel {
Y
Yu Yang 已提交
85 86 87
 public:
  using framework::OperatorWithKernel::OperatorWithKernel;

88
 protected:
D
dongzhihong 已提交
89 90 91 92 93
  void InferShape(const framework::InferShapeContext &ctx) const override {
    PADDLE_ENFORCE_NOT_NULL(ctx.InputVar("X"), "Input(X) should not be null");
    PADDLE_ENFORCE_NOT_NULL(ctx.InputVar("Y"), "Input(Y) should not be null");
    PADDLE_ENFORCE_NOT_NULL(ctx.InputVar(framework::GradVarName("Out")),
                            "Input(Out@GRAD) should not be null");
D
dongzhihong 已提交
94 95 96
    auto x_dims = ctx.Input<Tensor>("X")->dims();
    auto y_dims = ctx.Input<Tensor>("Y")->dims();
    auto out_dims = ctx.Input<Tensor>(framework::GradVarName("Out"))->dims();
D
dongzhihong 已提交
97 98
    auto *x_grad = ctx.Output<Tensor>(framework::GradVarName("X"));
    auto *y_grad = ctx.Output<Tensor>(framework::GradVarName("Y"));
99 100

    auto x_mat_dims =
F
fengjiayi 已提交
101
        framework::flatten_to_2d(x_dims, Attr<int>("x_num_col_dims"));
102
    auto y_mat_dims =
F
fengjiayi 已提交
103
        framework::flatten_to_2d(y_dims, Attr<int>("y_num_col_dims"));
104 105 106

    PADDLE_ENFORCE_EQ(
        x_mat_dims[0], out_dims[0],
F
WIP  
fengjiayi 已提交
107 108
        "The first dimension of Out@GRAD must equal to the first dimension of "
        "the first operand.");
109 110
    PADDLE_ENFORCE_EQ(
        y_mat_dims[1], out_dims[1],
111 112
        "The second dimension of Out@GRAD must equal to the second "
        "dimension of the second operand.");
D
dongzhihong 已提交
113

114 115
    if (x_grad) x_grad->Resize(x_dims);
    if (y_grad) y_grad->Resize(y_dims);
D
dongzhihong 已提交
116 117 118
  }
};

119 120 121
}  // namespace operators
}  // namespace paddle

D
dongzhihong 已提交
122
namespace ops = paddle::operators;
123
REGISTER_OP(mul, ops::MulOp, ops::MulOpMaker, mul_grad, ops::MulOpGrad);
D
dongzhihong 已提交
124
REGISTER_OP_CPU_KERNEL(mul, ops::MulKernel<paddle::platform::CPUPlace, float>);
D
dongzhihong 已提交
125 126
REGISTER_OP_CPU_KERNEL(mul_grad,
                       ops::MulGradKernel<paddle::platform::CPUPlace, float>);