sequence_pool_op.h

/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.

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. */

#pragma once
#include <string>
#include "paddle/fluid/framework/eigen.h"
#include "paddle/fluid/framework/op_registry.h"
#include "paddle/fluid/operators/math/math_function.h"
#include "paddle/fluid/operators/math/sequence_pooling.h"

namespace paddle {
namespace operators {

using Tensor = framework::Tensor;
using LoDTensor = framework::LoDTensor;

template <typename DeviceContext, typename T>
class SequencePoolKernel : public framework::OpKernel<T> {
 public:
  void Compute(const framework::ExecutionContext& context) const override {
    auto* in = context.Input<LoDTensor>("X");
    auto* out = context.Output<LoDTensor>("Out");
    std::string pooltype = context.Attr<std::string>("pooltype");
    T pad_value = static_cast<T>(context.Attr<float>("pad_value"));

    auto dims = in->dims();
    auto lod = in->lod();
    auto lod_level = lod.size();
    // InferShape by lod
    PADDLE_ENFORCE_GT(lod_level, 0, platform::errors::InvalidArgument(
                                        "Input(X) Tensor of SequencePoolOp "
                                        "does not contain LoD information."));
    PADDLE_ENFORCE_LE(lod_level, 2UL,
                      platform::errors::InvalidArgument(
                          "The lod level of input shall be no more than 2."
                          "Received lod level is %d.",
                          lod_level));
    PADDLE_ENFORCE_GE(
        dims[0],
        /*batch size = */ static_cast<int64_t>(lod[lod_level - 1].size() - 1),
        platform::errors::InvalidArgument(
            "The first dimension of Input(X) must be large than batch size."
            "But received first dimension of Input(X) is %d, while batch"
            "size is %d.",
            dims[0], static_cast<int64_t>(lod[lod_level - 1].size() - 1)));
    if (lod_level > 1UL) {
      PADDLE_ENFORCE_EQ(lod[0][lod[0].size() - 1], lod[1].size() - 1,
                        platform::errors::InvalidArgument(
                            "The input lod information is illegal."));
      framework::LoD out_lod;
      out_lod.push_back(lod[0]);
      out->set_lod(out_lod);
    }
    dims[0] = lod[lod_level - 1].size() - 1;
    out->Resize({dims});
    out->mutable_data<T>(context.GetPlace());
    Tensor* index = nullptr;

    bool is_test =
        context.HasAttr("is_test") ? context.Attr<bool>("is_test") : false;

    // Do not create index buffer for inference (is_test) mode
    // TODO(jczaja): Skip index buffer creation for other devices eg. GPU
    if (pooltype == "MAX" &&
        (is_test == false ||
         platform::is_cpu_place(context.GetPlace()) == false)) {
      index = context.Output<Tensor>("MaxIndex");
      index->Resize({dims});
      index->mutable_data<int>(context.GetPlace());
    }
    math::SequencePoolFunctor<DeviceContext, T> pool;
    pool(context.template device_context<DeviceContext>(), pooltype, pad_value,
         *in, out, is_test, index);
  }
};

template <typename DeviceContext, typename T>
class SequencePoolGradKernel : public framework::OpKernel<T> {
 public:
  void Compute(const framework::ExecutionContext& context) const override {
    auto* out_g = context.Input<LoDTensor>(framework::GradVarName("Out"));
    auto* in_g = context.Output<LoDTensor>(framework::GradVarName("X"));
    std::string pooltype = context.Attr<std::string>("pooltype");
    const Tensor* index = nullptr;
    if (pooltype == "MAX") {
      index = context.Input<Tensor>("MaxIndex");
    }
    in_g->mutable_data<T>(context.GetPlace());
    math::SequencePoolGradFunctor<DeviceContext, T> pool;
    pool(context.template device_context<DeviceContext>(), pooltype, *out_g,
         in_g, index);
  }
};

}  // namespace operators
}  // namespace paddle