op_desc.h 4.8 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
F
fengjiayi 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

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

A
Abhinav Arora 已提交
17
#include <string>
F
fengjiayi 已提交
18 19
#include <unordered_map>
#include <vector>
Y
Yi Wang 已提交
20 21 22
#include "paddle/fluid/framework/attribute.h"
#include "paddle/fluid/framework/type_defs.h"
#include "paddle/fluid/framework/var_desc.h"
F
fengjiayi 已提交
23 24 25 26

namespace paddle {
namespace framework {

Y
Yu Yang 已提交
27 28 29
class BlockDesc;
class ProgramDesc;
class OpDesc {
F
fengjiayi 已提交
30
 public:
Y
Yu Yang 已提交
31
  OpDesc() {}
F
fengjiayi 已提交
32

Y
Yu Yang 已提交
33 34
  OpDesc(const std::string &type, const VariableNameMap &inputs,
         const VariableNameMap &outputs, const AttributeMap &attrs);
F
fengjiayi 已提交
35

F
fengjiayi 已提交
36
  OpDesc(const proto::OpDesc &desc, BlockDesc *block);
37 38 39 40 41 42

  explicit OpDesc(BlockDesc *block) : block_(block) {}

  OpDesc(const OpDesc &other, BlockDesc *block) {
    *this = other;
    block_ = block;
F
fengjiayi 已提交
43
    need_update_ = true;
44
  }
45

46
  void CopyFrom(const OpDesc &op_desc);
F
fengjiayi 已提交
47

48
  proto::OpDesc *Proto();
F
fengjiayi 已提交
49

50
  std::string Type() const { return desc_.type(); }
F
fengjiayi 已提交
51

52
  void SetType(const std::string &type) { desc_.set_type(type); }
F
fengjiayi 已提交
53 54 55

  const std::vector<std::string> &Input(const std::string &name) const;

F
Update  
fengjiayi 已提交
56 57
  std::vector<std::string> InputArgumentNames() const;

F
fengjiayi 已提交
58 59 60 61 62
  void SetInput(const std::string &param_name,
                const std::vector<std::string> &args);

  const std::vector<std::string> &Output(const std::string &name) const;

F
Update  
fengjiayi 已提交
63 64
  std::vector<std::string> OutputArgumentNames() const;

F
fengjiayi 已提交
65 66 67 68 69 70 71
  void SetOutput(const std::string &param_name,
                 const std::vector<std::string> &args);

  bool HasAttr(const std::string &name) const {
    return attrs_.find(name) != attrs_.end();
  }

72
  proto::AttrType GetAttrType(const std::string &name) const;
F
fengjiayi 已提交
73 74 75 76 77

  std::vector<std::string> AttrNames() const;

  void SetAttr(const std::string &name, const Attribute &v);

A
Abhinav Arora 已提交
78
  void SetBlockAttr(const std::string &name, BlockDesc *block);
F
fengjiayi 已提交
79

80 81
  void SetBlocksAttr(const std::string &name, std::vector<BlockDesc *> blocks);

F
fengjiayi 已提交
82 83
  Attribute GetAttr(const std::string &name) const;

M
minqiyang 已提交
84
  const proto::OpProto::Attr &GetProtoAttr(const std::string &name) const;
M
minqiyang 已提交
85

Y
yuyang18 已提交
86
  Attribute GetNullableAttr(const std::string &name) const;
Y
Fix bug  
yuyang18 已提交
87

G
gongweibao 已提交
88 89 90
  int GetBlockAttrId(const std::string &name) const;

  std::vector<int> GetBlocksAttrIds(const std::string &name) const;
F
fengjiayi 已提交
91

F
fengjiayi 已提交
92 93
  void Rename(const std::string &old_name, const std::string &new_name);

Y
Yang Yang(Tony) 已提交
94 95 96 97
  void RenameOutput(const std::string &old_name, const std::string &new_name);

  void RenameInput(const std::string &old_name, const std::string &new_name);

F
fengjiayi 已提交
98
  // Only be used in C++
Y
Yu Yang 已提交
99
  const AttributeMap &GetAttrMap() const;
F
fengjiayi 已提交
100

101 102
  // Only be used in C++
  void SetAttrMap(const AttributeMap &attr_map);
103

Y
Yu Yang 已提交
104 105
  std::vector<std::string> InputNames() const { return MapKeys(inputs_); }
  std::vector<std::string> OutputNames() const { return MapKeys(outputs_); }
106

Y
Yu Yang 已提交
107
  void SetInputMap(const VariableNameMap &input) {
Y
Stash  
Yu Yang 已提交
108 109 110 111
    this->inputs_ = input;
    this->need_update_ = true;
  }

Y
Yu Yang 已提交
112
  void SetOutputMap(const VariableNameMap &output) {
Y
Stash  
Yu Yang 已提交
113 114 115 116
    this->outputs_ = output;
    this->need_update_ = true;
  }

Y
Yu Yang 已提交
117 118 119 120
  const VariableNameMap &Inputs() const { return inputs_; }

  const VariableNameMap &Outputs() const { return outputs_; }

121 122 123 124 125
  AttributeMap *MutableAttrMap() {
    this->need_update_ = true;
    return &this->attrs_;
  }

F
fengjiayi 已提交
126 127
  void CheckAttrs();

Y
Yu Yang 已提交
128
  void InferShape(const BlockDesc &block) const;
Y
Yu Yang 已提交
129

Y
Yu Yang 已提交
130
  void InferVarType(BlockDesc *block) const;
Y
Yu Yang 已提交
131

132
  void SetIsTarget(bool is_target) { desc_.set_is_target(is_target); }
133

134 135
  void Flush();

136 137
  BlockDesc *Block() { return this->block_; }

138 139
  const BlockDesc &BlockRef() const { return *this->block_; }

140 141
  void SetBlock(BlockDesc *block) { this->block_ = block; }

F
fengjiayi 已提交
142
 private:
143 144 145 146 147
  template <typename MapType>
  static std::vector<typename MapType::key_type> MapKeys(const MapType &map) {
    std::vector<typename MapType::key_type> ret_val;
    ret_val.reserve(map.size());
    std::transform(
Y
Fix CI  
Yu Yang 已提交
148
        map.begin(), map.end(), std::back_inserter(ret_val),
149 150 151 152
        [](const typename MapType::value_type &pair) { return pair.first; });
    return ret_val;
  }

153
  proto::OpDesc desc_;
154
  BlockDesc *block_;  // not_own
155
  // input arg name => input variable names
Y
Yu Yang 已提交
156
  VariableNameMap inputs_;
157
  // output arg name => output variable names
Y
Yu Yang 已提交
158 159
  VariableNameMap outputs_;
  AttributeMap attrs_;
F
fengjiayi 已提交
160 161 162 163 164

  // need_update_ indicate there some local changes not be synchronized. If
  // local changes should be synchronized, need_update_ should be set to true.
  bool need_update_{false};
};
F
fengjiayi 已提交
165 166
}  // namespace framework
}  // namespace paddle