squared_l2_distance_op.cc 5.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/* 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. */

#include "paddle/operators/squared_l2_distance_op.h"

namespace paddle {
namespace operators {

class SquaredL2DistanceOp : public framework::OperatorWithKernel {
 public:
  using framework::OperatorWithKernel::OperatorWithKernel;

 protected:
25
  void InferShape(const framework::InferShapeContext& ctx) const override {
26 27 28 29 30 31 32 33 34 35 36 37
    PADDLE_ENFORCE_NOT_NULL(
        ctx.InputVar("X"),
        "Input(X) of SquaredL2DistanceOp should not be null.");
    PADDLE_ENFORCE_NOT_NULL(
        ctx.InputVar("Y"),
        "Input(Y) of SquaredL2DistanceOp should not be null.");
    PADDLE_ENFORCE_NOT_NULL(
        ctx.OutputVar("sub_result"),
        "Output(sub_result) of SquaredL2DistanceOp should not be null.");
    PADDLE_ENFORCE_NOT_NULL(
        ctx.OutputVar("Out"),
        "Output(Out) of SquaredL2DistanceOp should not be null.");
38

39 40 41 42
    auto* x = ctx.Input<Tensor>("X");
    auto x_dims = x->dims();
    auto* y = ctx.Input<Tensor>("Y");
    auto y_dims = y->dims();
43

44
    PADDLE_ENFORCE_EQ(framework::arity(x_dims), framework::arity(y_dims),
45 46
                      "Tensor rank of both SquaredL2DistanceOp's "
                      "inputs must be same.");
47 48

    int rank = framework::arity(x_dims);
Y
yangyaming 已提交
49
    PADDLE_ENFORCE_GE(rank, 2, "Tensor rank should be at least equal to 2.");
50
    PADDLE_ENFORCE_EQ(x->numel() / x_dims[0], y->numel() / y_dims[0],
51 52 53
                      "Product of dimensions expcet the first dimension of "
                      "input and target must be equal.");
    PADDLE_ENFORCE(y_dims[0] == 1 || y_dims[0] == x_dims[0],
54 55 56
                   "First dimension of target must be equal to input "
                   "or to 1.");

57
    ctx.Output<framework::Tensor>("sub_result")
58
        ->Resize({x_dims[0], x->numel() / x_dims[0]});
59 60
    ctx.Output<framework::Tensor>("Out")->Resize({x_dims[0], 1});
    ctx.ShareLoD("X", /*->*/ "Out");
61 62 63 64 65
  }
};

class SquaredL2DistanceOpMaker : public framework::OpProtoAndCheckerMaker {
 public:
66 67
  SquaredL2DistanceOpMaker(framework::OpProto* proto,
                           framework::OpAttrChecker* op_checker)
68
      : OpProtoAndCheckerMaker(proto, op_checker) {
69 70
    AddInput("X", "Input of SquaredL2DistanceOp.");
    AddInput("Y", "Target of SquaredL2DistanceOp.");
71 72 73 74 75 76
    AddOutput("sub_result",
              "Buffering substraction result which "
              "will be reused in backward.")
        .AsIntermediate();
    AddOutput("Out", "Squared l2 distance between input and target.");
    AddComment(R"DOC(
77
    SquaredL2DistanceOp will cacluate the squared L2 distance for
78
    input and target. Number of distance value equals to the
79 80
    first dimension of input. First dimension of target could be equal to
    input or to 1. If the first dimension of target is 1, SquaredL2DistanceOp
81 82
    will broadcast target's first dimension to input's first dimension.
    You can decide whether calculate the gradient of input and target.
83 84 85

    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.
86 87 88 89 90 91 92 93 94
    )DOC");
  }
};

class SquaredL2DistanceGradOp : public framework::OperatorWithKernel {
 public:
  using framework::OperatorWithKernel::OperatorWithKernel;

 protected:
95 96 97
  void InferShape(const framework::InferShapeContext& ctx) const override {
    PADDLE_ENFORCE_NOT_NULL(ctx.InputVar(framework::GradVarName("Out")),
                            "Gradient of Out should not be null");
98 99 100 101
    auto out_dims = ctx.Input<Tensor>(framework::GradVarName("Out"))->dims();
    auto x_dims = ctx.Input<Tensor>("X")->dims();
    auto y_dims = ctx.Input<Tensor>("Y")->dims();
    PADDLE_ENFORCE_EQ(out_dims[0], x_dims[0],
102 103
                      "First dimension of output gradient and "
                      "input value must be equal.");
104
    PADDLE_ENFORCE_EQ(out_dims[1], 1,
105 106
                      "Second dimension of output gradient "
                      "must be 1.");
107 108
    auto* x_grad = ctx.Output<framework::Tensor>(framework::GradVarName("X"));
    auto* y_grad = ctx.Output<framework::Tensor>(framework::GradVarName("Y"));
Y
yangyaming 已提交
109 110
    if (x_grad) x_grad->Resize(x_dims);
    if (y_grad) y_grad->Resize(y_dims);
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
  }
};

}  // namespace operators
}  // namespace paddle

namespace ops = paddle::operators;
REGISTER_OP(squared_l2_distance, ops::SquaredL2DistanceOp,
            ops::SquaredL2DistanceOpMaker, squared_l2_distance_grad,
            ops::SquaredL2DistanceGradOp);
REGISTER_OP_CPU_KERNEL(
    squared_l2_distance,
    ops::SquaredL2DistanceKernel<paddle::platform::CPUPlace, float>);
REGISTER_OP_CPU_KERNEL(
    squared_l2_distance_grad,
    ops::SquaredL2DistanceGradKernel<paddle::platform::CPUPlace, float>);