attribute.h 8.1 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved.
Y
Yi Wang 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14

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. */

15 16 17 18 19
#pragma once

#include <functional>
#include <string>
#include <unordered_map>
Y
Yu Yang 已提交
20
#include <unordered_set>
21
#include <vector>
Y
Yi Wang 已提交
22

Y
Yi Wang 已提交
23 24 25
#include "paddle/fluid/framework/framework.pb.h"
#include "paddle/fluid/framework/type_defs.h"
#include "paddle/fluid/platform/enforce.h"
26 27 28

namespace paddle {
namespace framework {
Y
Yi Wang 已提交
29
template <typename T>
30
inline proto::AttrType AttrTypeID() {
Y
Yu Yang 已提交
31
  Attribute tmp = T();
32
  return static_cast<proto::AttrType>(tmp.which() - 1);
Y
Yu Yang 已提交
33
}
Y
Yi Wang 已提交
34

35
Attribute GetAttrValue(const proto::OpDesc::Attr& attr_desc);
Y
Yi Wang 已提交
36

Q
Qiao Longfei 已提交
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
class AttrReader {
 public:
  explicit AttrReader(const AttributeMap& attrs) : attrs_(attrs) {}

  template <typename T>
  inline const T& Get(const std::string& name) const {
    PADDLE_ENFORCE(attrs_.count(name) != 0, "%s should be in AttributeMap",
                   name);
    return boost::get<T>(attrs_.at(name));
  }

 private:
  const AttributeMap& attrs_;
};

52 53
// check whether a value(attribute) fit a certain limit
template <typename T>
F
fengjiayi 已提交
54
class GreaterThanChecker {
55
 public:
F
fengjiayi 已提交
56
  explicit GreaterThanChecker(T lower_bound) : lower_bound_(lower_bound) {}
57
  void operator()(T& value) const {
F
fengjiayi 已提交
58
    PADDLE_ENFORCE(value > lower_bound_, "larger_than check fails.");
59 60 61 62 63 64
  }

 private:
  T lower_bound_;
};

F
WIP  
fengjiayi 已提交
65
template <typename T>
F
fengjiayi 已提交
66
class EqualGreaterThanChecker {
F
WIP  
fengjiayi 已提交
67
 public:
F
fengjiayi 已提交
68
  explicit EqualGreaterThanChecker(T lower_bound) : lower_bound_(lower_bound) {}
F
WIP  
fengjiayi 已提交
69
  void operator()(T& value) const {
F
fengjiayi 已提交
70
    PADDLE_ENFORCE_GE(value, lower_bound_, "equal_larger_than check fails.");
F
WIP  
fengjiayi 已提交
71 72 73 74 75 76
  }

 private:
  T lower_bound_;
};

77 78 79 80 81 82
// we can provide users more common Checker, like 'LessThanChecker',
// 'BetweenChecker'...

template <typename T>
class DefaultValueSetter {
 public:
Y
Yi Wang 已提交
83 84
  explicit DefaultValueSetter(T default_value)
      : default_value_(default_value) {}
85 86 87 88 89 90
  void operator()(T& value) const { value = default_value_; }

 private:
  T default_value_;
};

Y
Yu Yang 已提交
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
template <typename T>
class EnumInContainer {
 public:
  explicit EnumInContainer(const std::unordered_set<T>& c) : container_(c) {}
  void operator()(T& val) const {
    PADDLE_ENFORCE(container_.find(val) != container_.end(),
                   "Value %s is not in enum container %s", val,
                   ContainerDebugString());
  }

 private:
  std::string ContainerDebugString() const {
    std::ostringstream sout;
    sout << "[";
    size_t cnt = 0;
    for (auto& v : container_) {
      sout << v;
      ++cnt;
      if (cnt != container_.size()) {
        sout << " ,";
      }
    }
    sout << "]";
    return sout.str();
  }

  std::unordered_set<T> container_;
};

120 121 122 123 124 125 126 127 128 129 130
template <typename T>
struct ExtractAttribute {
  explicit ExtractAttribute(const std::string& attr_name)
      : attr_name_(attr_name) {}

  T* operator()(Attribute& attr) const {
    T* attr_value = nullptr;
    try {
      attr_value = &boost::get<T>(attr);
    } catch (boost::bad_get& bad_get) {
      PADDLE_THROW("Cannot get attribute %s by type %s, its type is %s",
C
chenweihang 已提交
131 132
                   attr_name_, paddle::platform::demangle(typeid(T).name()),
                   paddle::platform::demangle(attr.type().name()));
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
    }
    return attr_value;
  }

  const std::string& attr_name_;
};

// special handle bool
// FIXME(yuyang18): Currently we cast bool into int in python binding. It is
// hard to change the logic there. In another way, we should correct handle
// if the user set `some_flag=1`.
//
// FIX ME anytime if there is a better solution.
template <>
struct ExtractAttribute<bool> {
  explicit ExtractAttribute(const std::string& attr_name)
      : attr_name_(attr_name) {}

  bool* operator()(Attribute& attr) const {
    if (attr.type() == typeid(int)) {  // NOLINT
      int val = boost::get<int>(attr);
      attr = static_cast<bool>(val);
    } else if (attr.type() == typeid(float)) {  // NOLINT
      float val = boost::get<float>(attr);
      attr = static_cast<bool>(val);
    }
    bool* attr_value = nullptr;
    try {
      attr_value = &boost::get<bool>(attr);
    } catch (boost::bad_get& bad_get) {
      PADDLE_THROW("Cannot get attribute %s by type bool, its type is %s",
C
chenweihang 已提交
164
                   attr_name_, paddle::platform::demangle(attr.type().name()));
165 166 167 168 169 170 171
    }
    return attr_value;
  }

  const std::string& attr_name_;
};

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
template <>
struct ExtractAttribute<int64_t> {
  explicit ExtractAttribute(const std::string& attr_name)
      : attr_name_(attr_name) {}

  int64_t* operator()(Attribute& attr) const {
    if (attr.type() == typeid(int)) {  // NOLINT
      int val = boost::get<int>(attr);
      attr = static_cast<int64_t>(val);
    } else if (attr.type() == typeid(float)) {  // NOLINT
      int val = boost::get<float>(attr);
      attr = static_cast<int64_t>(val);
    }
    int64_t* attr_value = nullptr;
    try {
      attr_value = &boost::get<int64_t>(attr);
    } catch (boost::bad_get& bad_get) {
      PADDLE_THROW("Cannot get attribute %s by type int64_t, its type is %s",
C
chenweihang 已提交
190
                   attr_name_, paddle::platform::demangle(attr.type().name()));
191 192 193 194 195 196 197
    }
    return attr_value;
  }

  const std::string& attr_name_;
};

198 199 200 201 202 203 204
// check whether a certain attribute fit its limits
// an attribute can have more than one limits
template <typename T>
class TypedAttrChecker {
  typedef std::function<void(T&)> ValueChecker;

 public:
Y
Yi Wang 已提交
205 206
  explicit TypedAttrChecker(const std::string& attr_name)
      : attr_name_(attr_name) {}
207

Y
Yu Yang 已提交
208 209 210 211 212
  TypedAttrChecker& InEnum(const std::unordered_set<T>& range) {
    value_checkers_.push_back(EnumInContainer<T>(range));
    return *this;
  }

F
fengjiayi 已提交
213 214
  TypedAttrChecker& GreaterThan(const T& lower_bound) {
    value_checkers_.push_back(GreaterThanChecker<T>(lower_bound));
215 216 217
    return *this;
  }

F
fengjiayi 已提交
218 219
  TypedAttrChecker& EqualGreaterThan(const T& lower_bound) {
    value_checkers_.push_back(EqualGreaterThanChecker<T>(lower_bound));
F
WIP  
fengjiayi 已提交
220 221 222
    return *this;
  }

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
  // we can add more common limits, like LessThan(), Between()...

  TypedAttrChecker& SetDefault(const T& default_value) {
    PADDLE_ENFORCE(default_value_setter_.empty(),
                   "%s can't have more than one default value!", attr_name_);
    default_value_setter_.push_back(DefaultValueSetter<T>(default_value));
    return *this;
  }

  // allow users provide their own checker
  TypedAttrChecker& AddCustomChecker(const ValueChecker& checker) {
    value_checkers_.push_back(checker);
    return *this;
  }

  void operator()(AttributeMap& attr_map) const {
    if (!attr_map.count(attr_name_)) {
      // user do not set this attr
      PADDLE_ENFORCE(!default_value_setter_.empty(),
                     "Attribute '%s' is required!", attr_name_);
      // default_value_setter_ has no more than one element
      T val;
      (default_value_setter_[0])(val);
      attr_map[attr_name_] = val;
    }
    Attribute& attr = attr_map.at(attr_name_);
249 250
    ExtractAttribute<T> extract_attr(attr_name_);
    T* attr_value = extract_attr(attr);
251
    for (const auto& checker : value_checkers_) {
252
      checker(*attr_value);
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
    }
  }

 private:
  std::string attr_name_;
  std::vector<ValueChecker> value_checkers_;
  std::vector<ValueChecker> default_value_setter_;
};

// check whether op's all attributes fit their own limits
class OpAttrChecker {
  typedef std::function<void(AttributeMap&)> AttrChecker;

 public:
  template <typename T>
  TypedAttrChecker<T>& AddAttrChecker(const std::string& attr_name) {
    attr_checkers_.push_back(TypedAttrChecker<T>(attr_name));
    AttrChecker& checker = attr_checkers_.back();
    return *(checker.target<TypedAttrChecker<T>>());
  }

  void Check(AttributeMap& attr_map) const {
    for (const auto& checker : attr_checkers_) {
      checker(attr_map);
    }
  }

 private:
  std::vector<AttrChecker> attr_checkers_;
};

}  // namespace framework
}  // namespace paddle