mul_op.cc 5.2 KB
Newer Older
1 2
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.

3 4 5
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
6

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

9 10 11 12 13
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. */
14

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:
27
  void InferShape(framework::InferShapeContext* ctx) const override {
Q
Qiao Longfei 已提交
28 29 30 31 32 33 34 35 36
    PADDLE_ENFORCE(ctx->HasInput("X"), "Input(X) of MulOp should not be null.");
    PADDLE_ENFORCE(ctx->HasInput("Y"), "Input(Y) of MulOp should not be null.");
    PADDLE_ENFORCE(ctx->HasOutput("Out"),
                   "Output(Out) of MulOp should not be null.");

    auto x_dims = ctx->GetInputDim("X");
    auto y_dims = ctx->GetInputDim("Y");
    int x_num_col_dims = ctx->Attrs().Get<int>("x_num_col_dims");
    int y_num_col_dims = ctx->Attrs().Get<int>("y_num_col_dims");
F
WIP  
fengjiayi 已提交
37

38 39 40 41 42 43 44 45
    PADDLE_ENFORCE_GT(
        x_dims.size(), x_num_col_dims,
        "The input tensor X's rank of MulOp should be larger than "
        "x_num_col_dims.");
    PADDLE_ENFORCE_GT(
        y_dims.size(), y_num_col_dims,
        "The input tensor Y's rank of MulOp should be larger than "
        "y_num_col_dims.");
46

F
fengjiayi 已提交
47 48
    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);
49

Y
Yan Chunwei 已提交
50
    PADDLE_ENFORCE_EQ(
51
        x_mat_dims[1], y_mat_dims[0],
52
        "First matrix's width must be equal with second matrix's height.");
Q
Qiao Longfei 已提交
53 54
    ctx->SetOutputDim("Out", {x_mat_dims[0], y_mat_dims[1]});
    ctx->ShareLoD("X", /*->*/ "Out");
55 56 57
  }
};

D
dongzhihong 已提交
58
class MulOpMaker : public framework::OpProtoAndCheckerMaker {
59
 public:
Q
Qiao Longfei 已提交
60
  MulOpMaker(framework::OpProto* proto, framework::OpAttrChecker* op_checker)
61
      : OpProtoAndCheckerMaker(proto, op_checker) {
62 63 64
    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 已提交
65
    AddAttr<int>(
F
fengjiayi 已提交
66
        "x_num_col_dims",
Q
Qiao Longfei 已提交
67 68 69
        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
F
fengjiayi 已提交
70 71 72
            `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 已提交
73
        .SetDefault(1)
F
fengjiayi 已提交
74
        .EqualGreaterThan(1);
F
WIP  
fengjiayi 已提交
75
    AddAttr<int>(
F
fengjiayi 已提交
76
        "y_num_col_dims",
F
fengjiayi 已提交
77 78 79
        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 已提交
80
        .SetDefault(1)
F
fengjiayi 已提交
81
        .EqualGreaterThan(1);
82
    AddComment(R"DOC(
83
Mul operator is used to perform matrix multiplication for input X and Y.
84

85 86 87 88 89 90
The equation is:

    Out = X * Y

Both the input `X` and `Y` can carry the LoD (Level of Details) information,
or not. But the output only shares the LoD with input `X`.
91 92 93 94
)DOC");
  }
};

D
dongzhihong 已提交
95
class MulOpGrad : public framework::OperatorWithKernel {
Y
Yu Yang 已提交
96 97 98
 public:
  using framework::OperatorWithKernel::OperatorWithKernel;

99
 protected:
100
  void InferShape(framework::InferShapeContext* ctx) const override {
Q
Qiao Longfei 已提交
101 102 103 104 105 106 107
    PADDLE_ENFORCE(ctx->HasInput("X"), "Input(X) should not be null");
    PADDLE_ENFORCE(ctx->HasInput("Y"), "Input(Y) should not be null");
    PADDLE_ENFORCE(ctx->HasInput(framework::GradVarName("Out")),
                   "Input(Out@GRAD) should not be null");
    auto x_dims = ctx->GetInputDim("X");
    auto y_dims = ctx->GetInputDim("Y");
    auto out_dims = ctx->GetInputDim(framework::GradVarName("Out"));
108 109

    auto x_mat_dims =
F
fengjiayi 已提交
110
        framework::flatten_to_2d(x_dims, Attr<int>("x_num_col_dims"));
111
    auto y_mat_dims =
F
fengjiayi 已提交
112
        framework::flatten_to_2d(y_dims, Attr<int>("y_num_col_dims"));
113 114 115

    PADDLE_ENFORCE_EQ(
        x_mat_dims[0], out_dims[0],
F
WIP  
fengjiayi 已提交
116 117
        "The first dimension of Out@GRAD must equal to the first dimension of "
        "the first operand.");
118 119
    PADDLE_ENFORCE_EQ(
        y_mat_dims[1], out_dims[1],
120 121
        "The second dimension of Out@GRAD must equal to the second "
        "dimension of the second operand.");
D
dongzhihong 已提交
122

Q
Qiao Longfei 已提交
123 124 125 126 127 128 129 130 131
    auto x_grad_name = framework::GradVarName("X");
    auto y_grad_name = framework::GradVarName("Y");

    if (ctx->HasOutput(x_grad_name)) {
      ctx->SetOutputDim(x_grad_name, x_dims);
    }
    if (ctx->HasOutput(y_grad_name)) {
      ctx->SetOutputDim(y_grad_name, y_dims);
    }
D
dongzhihong 已提交
132 133 134
  }
};

135 136 137
}  // namespace operators
}  // namespace paddle

D
dongzhihong 已提交
138
namespace ops = paddle::operators;
139
REGISTER_OP(mul, ops::MulOp, ops::MulOpMaker, mul_grad, ops::MulOpGrad);
D
dongzhihong 已提交
140
REGISTER_OP_CPU_KERNEL(mul, ops::MulKernel<paddle::platform::CPUPlace, float>);
D
dongzhihong 已提交
141 142
REGISTER_OP_CPU_KERNEL(mul_grad,
                       ops::MulGradKernel<paddle::platform::CPUPlace, float>);