index_add_op.cc

// Copyright (c) 2022 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.

#include <memory>

#include "paddle/fluid/framework/infershape_utils.h"
#include "paddle/fluid/framework/op_registry.h"
#include "paddle/phi/infermeta/backward.h"
#include "paddle/phi/infermeta/binary.h"

namespace paddle {
namespace operators {

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

  framework::OpKernelType GetExpectedKernelType(
      const framework::ExecutionContext& ctx) const override {
    return framework::OpKernelType(
        OperatorWithKernel::IndicateVarDataType(ctx, "X"), ctx.GetPlace());
  }
};

class IndexAddOpMaker : public framework::OpProtoAndCheckerMaker {
 public:
  void Make() override {
    AddInput("X",
             "(Tensor), "
             "the input feature data of IndexAddOp, dtype should be"
             "bool, int32, int64, float16, float32, float64.");
    AddInput("Index",
             "(Tensor), the 1-D tensor containing the indices to index.");
    AddInput("AddValue", "(Tensor), the tensor containing values to add.");
    AddOutput(
        "Out",
        "(Tensor),"
        " the output of  IndexAddOp, whose dtype and shape are the same as X.");
    AddAttr<int>("axis", "the dimension in which we index.").SetDefault(0);
    AddComment(R"DOC(
                IndexAdd operator
                Add the elements of the input tensor with value
                by selecting the indices in the order given in index.
                This operator also supports inplace modification.
        )DOC");
  }
};

template <typename T>
class IndexAddGradMaker : public framework::SingleGradOpMaker<T> {
 public:
  using framework::SingleGradOpMaker<T>::SingleGradOpMaker;

  void Apply(GradOpPtr<T> op) const override {
    op->SetType("index_add_grad");
    op->SetInput("Index", this->Input("Index"));
    op->SetInput("AddValue", this->Input("AddValue"));
    op->SetInput(framework::GradVarName("Out"), this->OutputGrad("Out"));
    op->SetAttrMap(this->Attrs());
    op->SetOutput(framework::GradVarName("X"), this->InputGrad("X"));
    op->SetOutput(framework::GradVarName("AddValue"),
                  this->InputGrad("AddValue"));
  }
};

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

 protected:
  framework::OpKernelType GetExpectedKernelType(
      const framework::ExecutionContext& ctx) const override {
    return framework::OpKernelType(OperatorWithKernel::IndicateVarDataType(
                                       ctx, framework::GradVarName("Out")),
                                   ctx.GetPlace());
  }
};

DECLARE_INPLACE_OP_INFERER(IndexAddInplaceInferer, {"X", "Out"});
DECLARE_INPLACE_OP_INFERER(IndexAddGradInplaceInferer,
                           {framework::GradVarName("Out"),
                            framework::GradVarName("X")});

}  // namespace operators
}  // namespace paddle

namespace ops = paddle::operators;
DECLARE_INFER_SHAPE_FUNCTOR(index_add,
                            IndexAddInferShapeFunctor,
                            PD_INFER_META(phi::IndexAddInferMeta));

REGISTER_OPERATOR(index_add,
                  ops::IndexAddOp,
                  ops::IndexAddOpMaker,
                  ops::IndexAddGradMaker<paddle::framework::OpDesc>,
                  ops::IndexAddGradMaker<paddle::imperative::OpBase>,
                  ops::IndexAddInplaceInferer,
                  IndexAddInferShapeFunctor);

DECLARE_INFER_SHAPE_FUNCTOR(index_add_grad,
                            IndexAddGradInferShapeFunctor,
                            PD_INFER_META(phi::IndexAddGradInferMeta));

REGISTER_OPERATOR(index_add_grad,
                  ops::IndexAddGradOp,
                  ops::IndexAddGradInplaceInferer,
                  IndexAddGradInferShapeFunctor);