op_proto_maker.h 3.1 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>
R
reyoung 已提交
17
#include "glog/logging.h"
Y
Yi Wang 已提交
18 19
#include "paddle/fluid/framework/attribute.h"
#include "paddle/fluid/framework/framework.pb.h"
20 21 22
namespace paddle {
namespace framework {

X
Xin Pan 已提交
23 24 25
//////////////////////////
// Don't add more roles to make this too complicated!
//////////////////////////
Y
yuyang18 已提交
26 27 28 29
enum class OpRole {
  kForward = 0x0000,
  kBackward = 0x0001,
  kOptimize = 0x0002,
30
  // RPC role is for send/recv releated op
Y
Yancey1989 已提交
31
  kRPC = 0x0003,
32 33 34 35 36
  // Dist role is for split_byref/split_selected_rows/concat
  // used for distributed training.
  kDist = 0x0004,
  // Tag all learning rate scheduler operators.
  kLRSched = 0x0005,
Y
yuyang18 已提交
37 38

  kLoss = 0x0100,
Y
yuyang18 已提交
39 40 41
  // The default value of op's role. This should be only used for unittests and
  // CreateOp inside a operator.
  kNotSpecified = 0x1000,
Y
yuyang18 已提交
42 43
};

44 45 46
// this class not only make proto but also init attribute checkers.
class OpProtoAndCheckerMaker {
 public:
Y
yuyang18 已提交
47 48
  static const char *OpRoleAttrName() { return "op_role"; }
  static const char *OpRoleVarAttrName() { return "op_role_var"; }
49
  static const char *OpNamescopeAttrName() { return "op_namescope"; }
Y
yuyang18 已提交
50 51 52

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

Y
Yu Yang 已提交
53
  virtual void Make() = 0;
54

55
  virtual ~OpProtoAndCheckerMaker() {
R
reyoung 已提交
56
    CHECK(validated_) << "should call Validate after build";
57 58 59 60
  }

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

R
reyoung 已提交
63
    VariableBuilder &AsDuplicable() {
64 65 66 67
      var_->set_duplicable(true);
      return *this;
    }

R
reyoung 已提交
68
    VariableBuilder &AsIntermediate() {
69 70 71
      var_->set_intermediate(true);
      return *this;
    }
Y
Yang Yang 已提交
72

R
reyoung 已提交
73
    VariableBuilder &AsDispensable() {
Y
Yang Yang 已提交
74 75 76
      var_->set_dispensable(true);
      return *this;
    }
77 78
  };

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

R
reyoung 已提交
81 82
  VariableBuilder AddOutput(const std::string &name,
                            const std::string &comment);
83 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

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