split_selected_rows_op.cc

/* 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/split_selected_rows_op.h"

namespace paddle {
namespace operators {

class SplitSelectedRowsOpMaker : public framework::OpProtoAndCheckerMaker {
 public:
  SplitSelectedRowsOpMaker(OpProto *proto, OpAttrChecker *op_checker)
      : OpProtoAndCheckerMaker(proto, op_checker) {
    AddInput("X", "The input SelectedRows.");
    AddOutput("Out", "The outputs of input SelectedRows.").AsDuplicable();
    AddAttr<std::vector<int>>("rows_sections", "Rows section for output.")
        .SetDefault(std::vector<int>({}));
    AddAttr<std::vector<int>>("height_sections",
                              "Height for each output SelectedRows.")
        .SetDefault(std::vector<int>({}));

    AddComment(R"DOC(
Split a SelectedRows with a specified rows section.
height_sections is only needed when need to split the dims of the original tensor.

Example:
  Input:
    X.rows = {0, 7, 5}
    X.height = 12
  Attr:
    rows_sections = {1, 2}
    height_sections = {}
  Out:
    out0.rows = {0}
    out0.height = 12
    out1.rows = {7, 5}
    out2.height = 12

)DOC");
  }
};

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

  void InferShape(framework::InferShapeContext *ctx) const override {
    PADDLE_ENFORCE(ctx->HasInput("X"), "SplitSelectedRowsOp must has input X.");
    PADDLE_ENFORCE(ctx->HasOutputs("Out"),
                   "SplitSelectedRowsOp must has output Out.");

    std::vector<int> height_sections =
        ctx->Attrs().Get<std::vector<int>>("height_sections");
    std::vector<int> rows_sections =
        ctx->Attrs().Get<std::vector<int>>("rows_sections");
    PADDLE_ENFORCE_EQ(
        rows_sections.size(), ctx->Outputs("Out").size(),
        "The size of rows section should be the same with Outputs size.");
    int64_t n = ctx->Outputs("Out").size();

    std::vector<framework::DDim> outs_dims;
    outs_dims.reserve(n);

    // make output dims
    for (int64_t i = 0; i < n; ++i) {
      auto dims = ctx->GetInputDim("X");
      if (height_sections.size()) {
        PADDLE_ENFORCE_EQ(
            height_sections.size(), static_cast<size_t>(n),
            "The size of height section should be the same with height"
            " section size.");
        dims[0] = height_sections[i];
      }
      outs_dims.push_back(dims);
    }
    ctx->SetOutputsDim("Out", outs_dims);
  }
};

class SplitSelectedRowsGradMaker : public framework::SingleGradOpDescMaker {
 public:
  using framework::SingleGradOpDescMaker::SingleGradOpDescMaker;

 protected:
  std::unique_ptr<framework::OpDesc> Apply() const override {
    auto *grad_op = new framework::OpDesc();
    grad_op->SetType("sum");
    grad_op->SetInput("X", OutputGrad("Out"));
    grad_op->SetOutput("Out", InputGrad("X"));
    grad_op->SetAttrMap(Attrs());
    return std::unique_ptr<framework::OpDesc>(grad_op);
  }
};

}  // namespace operators
}  // namespace paddle

namespace ops = paddle::operators;
REGISTER_OPERATOR(split_selected_rows, ops::SplitSelectedRowsOp,
                  ops::SplitSelectedRowsOpMaker,
                  ops::SplitSelectedRowsGradMaker);
REGISTER_OP_CPU_KERNEL(
    split_selected_rows,
    ops::SplitSelectedRowsOpKernel<paddle::platform::CPUPlace, float>);