attribute.h 11.3 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 {
T
tangwei12 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

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",
                   attr_name_, paddle::platform::demangle(typeid(T).name()),
                   paddle::platform::demangle(attr.type().name()));
    }
    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",
                   attr_name_, paddle::platform::demangle(attr.type().name()));
    }
    return attr_value;
  }

  const std::string& attr_name_;
};

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",
                   attr_name_, paddle::platform::demangle(attr.type().name()));
    }
    return attr_value;
  }

  const std::string& attr_name_;
};

template <>
struct ExtractAttribute<std::vector<int64_t>> {
  explicit ExtractAttribute(const std::string& attr_name)
      : attr_name_(attr_name) {}

  std::vector<int64_t>* operator()(Attribute& attr) const {
    if (attr.type() == typeid(std::vector<int>)) {  // NOLINT
      std::vector<int> val = boost::get<std::vector<int>>(attr);
      std::vector<int64_t> vec(val.begin(), val.end());
      attr = vec;
    } else if (attr.type() == typeid(std::vector<float>)) {  // NOLINT
      std::vector<float> val = boost::get<std::vector<float>>(attr);
      std::vector<int64_t> vec(val.begin(), val.end());
      attr = vec;
    }
    std::vector<int64_t>* attr_value = nullptr;
    try {
      attr_value = &boost::get<std::vector<int64_t>>(attr);
    } catch (boost::bad_get& bad_get) {
      PADDLE_THROW("Cannot get attribute %s by type int64_t, its type is %s",
                   attr_name_, paddle::platform::demangle(attr.type().name()));
    }
    return attr_value;
  }

  const std::string& attr_name_;
};
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

template <>
struct ExtractAttribute<float> {
  explicit ExtractAttribute(const std::string& attr_name)
      : attr_name_(attr_name) {}

  float* operator()(Attribute& attr) const {
    if (attr.type() == typeid(int)) {  // NOLINT
      int val = boost::get<int>(attr);
      attr = static_cast<float>(val);
    } else if (attr.type() == typeid(int64_t)) {  // NOLINT
      int64_t val = boost::get<int64_t>(attr);
      attr = static_cast<float>(val);
    }
    float* attr_value = nullptr;
    try {
      attr_value = &boost::get<float>(attr);
    } catch (boost::bad_get& bad_get) {
      PADDLE_THROW("Cannot get attribute %s by type float, its type is %s",
                   attr_name_, paddle::platform::demangle(attr.type().name()));
    }
    return attr_value;
  }

  const std::string& attr_name_;
};
T
tangwei12 已提交
161

Y
Yi Wang 已提交
162
template <typename T>
163
inline proto::AttrType AttrTypeID() {
Y
Yu Yang 已提交
164
  Attribute tmp = T();
165
  return static_cast<proto::AttrType>(tmp.which() - 1);
Y
Yu Yang 已提交
166
}
Y
Yi Wang 已提交
167

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

Q
Qiao Longfei 已提交
170 171 172 173 174 175 176 177
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);
T
tangwei12 已提交
178 179 180 181 182

    Attribute& attr = const_cast<Attribute&>(attrs_.at(name));
    ExtractAttribute<T> extract_attr(name);
    T* attr_value = extract_attr(attr);
    return *attr_value;
Q
Qiao Longfei 已提交
183 184 185 186 187 188
  }

 private:
  const AttributeMap& attrs_;
};

189 190
// check whether a value(attribute) fit a certain limit
template <typename T>
F
fengjiayi 已提交
191
class GreaterThanChecker {
192
 public:
F
fengjiayi 已提交
193
  explicit GreaterThanChecker(T lower_bound) : lower_bound_(lower_bound) {}
T
tangwei12 已提交
194
  void operator()(const T& value) const {
195 196
    PADDLE_ENFORCE_GT(value, lower_bound_,
                      platform::errors::OutOfRange("larger_than check fails."));
197 198 199 200 201 202
  }

 private:
  T lower_bound_;
};

F
WIP  
fengjiayi 已提交
203
template <typename T>
F
fengjiayi 已提交
204
class EqualGreaterThanChecker {
F
WIP  
fengjiayi 已提交
205
 public:
F
fengjiayi 已提交
206
  explicit EqualGreaterThanChecker(T lower_bound) : lower_bound_(lower_bound) {}
T
tangwei12 已提交
207
  void operator()(const T& value) const {
F
fengjiayi 已提交
208
    PADDLE_ENFORCE_GE(value, lower_bound_, "equal_larger_than check fails.");
F
WIP  
fengjiayi 已提交
209 210 211 212 213 214
  }

 private:
  T lower_bound_;
};

215 216 217 218 219 220
// we can provide users more common Checker, like 'LessThanChecker',
// 'BetweenChecker'...

template <typename T>
class DefaultValueSetter {
 public:
Y
Yi Wang 已提交
221 222
  explicit DefaultValueSetter(T default_value)
      : default_value_(default_value) {}
H
hong 已提交
223
  const T& operator()() const { return default_value_; }
224 225 226 227 228

 private:
  T default_value_;
};

Y
Yu Yang 已提交
229 230 231 232
template <typename T>
class EnumInContainer {
 public:
  explicit EnumInContainer(const std::unordered_set<T>& c) : container_(c) {}
T
tangwei12 已提交
233
  void operator()(const T& val) const {
Y
Yu Yang 已提交
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
    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_;
};

258 259 260 261
// check whether a certain attribute fit its limits
// an attribute can have more than one limits
template <typename T>
class TypedAttrChecker {
H
hong 已提交
262
  typedef std::function<const T&()> DefaultValueChecker;
T
tangwei12 已提交
263
  typedef std::function<void(const T&)> ValueChecker;
264 265

 public:
Y
Yi Wang 已提交
266 267
  explicit TypedAttrChecker(const std::string& attr_name)
      : attr_name_(attr_name) {}
268

Y
Yu Yang 已提交
269 270 271 272 273
  TypedAttrChecker& InEnum(const std::unordered_set<T>& range) {
    value_checkers_.push_back(EnumInContainer<T>(range));
    return *this;
  }

F
fengjiayi 已提交
274 275
  TypedAttrChecker& GreaterThan(const T& lower_bound) {
    value_checkers_.push_back(GreaterThanChecker<T>(lower_bound));
276 277 278
    return *this;
  }

F
fengjiayi 已提交
279 280
  TypedAttrChecker& EqualGreaterThan(const T& lower_bound) {
    value_checkers_.push_back(EqualGreaterThanChecker<T>(lower_bound));
F
WIP  
fengjiayi 已提交
281 282 283
    return *this;
  }

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
  // 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;
  }

299 300 301 302 303 304 305 306 307
  void operator()(AttributeMap* attr_map,
                  bool get_default_value_only = false) const {
    if (get_default_value_only) {
      if (!default_value_setter_.empty()) {
        attr_map->emplace(attr_name_, default_value_setter_[0]());
      }
      return;
    }

H
hong 已提交
308 309
    auto it = attr_map->find(attr_name_);
    if (it == attr_map->end()) {
310 311 312 313
      // 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
H
hong 已提交
314
      attr_map->emplace(attr_name_, default_value_setter_[0]());
315
    }
H
hong 已提交
316
    it = attr_map->find(attr_name_);
317
    ExtractAttribute<T> extract_attr(attr_name_);
H
hong 已提交
318
    T* attr_value = extract_attr(it->second);
319
    for (const auto& checker : value_checkers_) {
320
      checker(*attr_value);
321 322 323 324 325 326
    }
  }

 private:
  std::string attr_name_;
  std::vector<ValueChecker> value_checkers_;
T
tangwei12 已提交
327
  std::vector<DefaultValueChecker> default_value_setter_;
328 329 330 331
};

// check whether op's all attributes fit their own limits
class OpAttrChecker {
332
  typedef std::function<void(AttributeMap*, bool)> AttrChecker;
333 334 335 336 337 338 339 340 341

 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>>());
  }

342 343 344 345 346
  void Check(AttributeMap* attr_map, bool explicit_only = false) const {
    auto checker_num = attr_checkers_.size();
    if (explicit_only) checker_num = explicit_checker_num_;
    for (size_t i = 0; i < checker_num; ++i) {
      attr_checkers_[i](attr_map, false);
347 348 349 350 351 352 353
    }
  }

  AttributeMap GetAttrsDefaultValuesMap() const {
    AttributeMap default_values_map;
    for (const auto& checker : attr_checkers_) {
      checker(&default_values_map, true);
354
    }
355
    return default_values_map;
356 357
  }

358 359 360 361
  void RecordExplicitCheckerNum() {
    explicit_checker_num_ = attr_checkers_.size();
  }

362 363
 private:
  std::vector<AttrChecker> attr_checkers_;
364 365 366 367 368 369 370 371 372

  // in order to improve the efficiency of dynamic graph mode,
  // we divede the attribute into explicit type and implicit type.
  // for explicit attribute, we mean the attribute added in the customized
  // op makers, usually it's defined in the overloaded Make method.
  // for implicit attribute, we mean the attribute added outside of the Make
  // method like "op_role", "op_role_var", and they are useless in dynamic graph
  // mode
  size_t explicit_checker_num_;
373 374 375 376
};

}  // namespace framework
}  // namespace paddle