einsum_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 <string>
#include <vector>
#include "paddle/fluid/framework/infershape_utils.h"
#include "paddle/fluid/framework/op_registry.h"
#include "paddle/fluid/framework/operator.h"
#include "paddle/phi/core/ddim.h"
#include "paddle/phi/infermeta/unary.h"

namespace paddle {
namespace operators {
class EinsumOp : public framework::OperatorWithKernel {
 public:
  using framework::OperatorWithKernel::OperatorWithKernel;
};

class EinsumOpMaker : public framework::OpProtoAndCheckerMaker {
 public:
  void Make() override {
    AddInput("Operands", "(TensorList), The input tensor of einsum op.")
        .AsDuplicable();
    AddOutput("Out", "(Tensor), The output tensor of einsum op.");
    AddOutput(
        "InnerCache",
        "(Tensor), The cache of the forward transpose tensors: tA and tB.")
        .AsDuplicable()
        .AsExtra()
        .AsIntermediate();

    AddOutput("XShape", "(Tensor), The cache of the x_shape of: A and B.")
        .AsDuplicable()
        .AsExtra()
        .AsIntermediate();
    AddAttr<std::string>("equation",
                         "(string) A einsum equation. such as `ij,jk->ik`"
                         "There must have `->` and the number of operands in "
                         "equation must equals the `Operands` length.");
    AddComment(R"DOC(
Einsum Operator.

This operator is used to perform einsum operation for given operands and equation.
)DOC");
  }
};

class EinsumGradOp : public framework::OperatorWithKernel {
 public:
  using framework::OperatorWithKernel::OperatorWithKernel;
  void InferShape(framework::InferShapeContext* ctx) const override {
    auto x_name = "Operands";
    auto x_grad_name = framework::GradVarName(x_name);
    ctx->SetOutputsDim(x_grad_name, ctx->GetInputsDim("Operands"));
    ctx->ShareAllLoD("Operands", x_grad_name);
  }

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

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

  void Apply(GradOpPtr<T> retv) const override {
    retv->SetType("einsum_grad");
    if (this->HasOutput("InnerCache")) {
      retv->SetInput("InnerCache", this->Output("InnerCache"));
    }
    if (this->HasOutput("XShape")) {
      // add if for compatibility.
      retv->SetInput("Operands", this->Output("XShape"));  // for memory save.
    } else {
      retv->SetInput("Operands", this->Input("Operands"));
    }
    retv->SetInput(framework::GradVarName("Out"), this->OutputGrad("Out"));
    retv->SetAttrMap(this->Attrs());
    retv->SetOutput(framework::GradVarName("Operands"),
                    this->InputGrad("Operands", false));
  }
};

}  // namespace operators
}  // namespace paddle

namespace ops = paddle::operators;

DECLARE_INFER_SHAPE_FUNCTOR(einsum, EinsumInferShapeFunctor,
                            PD_INFER_META(phi::EinsumInferMeta));

REGISTER_OPERATOR(einsum, ops::EinsumOp, ops::EinsumOpMaker,
                  EinsumInferShapeFunctor,
                  ops::EinsumGradMaker<paddle::framework::OpDesc>,
                  ops::EinsumGradMaker<paddle::imperative::OpBase>);

REGISTER_OPERATOR(einsum_grad, ops::EinsumGradOp);