op_proto_maker.h 3.0 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14 15
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

16
#include <string>
17 18
#include <unordered_set>

R
reyoung 已提交
19
#include "glog/logging.h"
Y
Yi Wang 已提交
20 21
#include "paddle/fluid/framework/attribute.h"
#include "paddle/fluid/framework/framework.pb.h"
22 23 24
namespace paddle {
namespace framework {

Y
yuyang18 已提交
25 26 27 28
enum class OpRole {
  kForward = 0x0000,
  kBackward = 0x0001,
  kOptimize = 0x0002,
Y
Yancey1989 已提交
29
  kRPC = 0x0003,
Y
yuyang18 已提交
30 31

  kLoss = 0x0100,
Y
yuyang18 已提交
32 33 34
  // The default value of op's role. This should be only used for unittests and
  // CreateOp inside a operator.
  kNotSpecified = 0x1000,
Y
yuyang18 已提交
35 36
};

37 38 39
// this class not only make proto but also init attribute checkers.
class OpProtoAndCheckerMaker {
 public:
Y
yuyang18 已提交
40 41
  static const char *OpRoleAttrName() { return "op_role"; }
  static const char *OpRoleVarAttrName() { return "op_role_var"; }
42
  static const char *OpNamescopeAttrName() { return "op_namescope"; }
Y
yuyang18 已提交
43 44 45

  void operator()(proto::OpProto *proto, OpAttrChecker *attr_checker);

Y
Yu Yang 已提交
46
  virtual void Make() = 0;
47

48
  virtual ~OpProtoAndCheckerMaker() {
R
reyoung 已提交
49
    CHECK(validated_) << "should call Validate after build";
50 51 52 53
  }

 protected:
  struct VariableBuilder {
R
reyoung 已提交
54
    proto::OpProto::Var *var_;
55

R
reyoung 已提交
56
    VariableBuilder &AsDuplicable() {
57 58 59 60
      var_->set_duplicable(true);
      return *this;
    }

R
reyoung 已提交
61
    VariableBuilder &AsIntermediate() {
62 63 64
      var_->set_intermediate(true);
      return *this;
    }
Y
Yang Yang 已提交
65

R
reyoung 已提交
66
    VariableBuilder &AsDispensable() {
Y
Yang Yang 已提交
67 68 69
      var_->set_dispensable(true);
      return *this;
    }
70 71 72 73 74

    VariableBuilder &Reuse(const std::string &name) {
      var_->set_reuse(name);
      return *this;
    }
75 76
  };

R
reyoung 已提交
77
  VariableBuilder AddInput(const std::string &name, const std::string &comment);
78

R
reyoung 已提交
79 80
  VariableBuilder AddOutput(const std::string &name,
                            const std::string &comment);
81

82 83
  void Reuse(const std::string &name, const std::string &reused_name);

84
  template <typename T>
R
reyoung 已提交
85 86
  TypedAttrChecker<T> &AddAttr(const std::string &name,
                               const std::string &comment,
87
                               bool generated = false) {
R
reyoung 已提交
88
    auto *attr = proto_->add_attrs();
89 90 91 92 93 94 95
    attr->set_name(name);
    attr->set_comment(comment);
    attr->set_generated(generated);
    attr->set_type(AttrTypeID<T>());
    return op_checker_->AddAttrChecker<T>(name);
  }

R
reyoung 已提交
96
  void AddComment(const std::string &comment) { proto_->set_comment(comment); }
97 98 99

 private:
  void CheckNoDuplicatedInOutAttrs();
Y
yuyang18 已提交
100
  void Validate();
101

102 103
  void CheckReuseVars();

R
reyoung 已提交
104 105
  proto::OpProto *proto_;
  OpAttrChecker *op_checker_;
106 107 108 109
  bool validated_{false};
};
}  // namespace framework
}  // namespace paddle