tiny_dnn  1.0.0
A header only, dependency-free deep learning framework in C++11
serialization_helper.h
1 /*
2  Copyright (c) 2016, Taiga Nomi
3  All rights reserved.
4 
5  Redistribution and use in source and binary forms, with or without
6  modification, are permitted provided that the following conditions are met:
7  * Redistributions of source code must retain the above copyright
8  notice, this list of conditions and the following disclaimer.
9  * Redistributions in binary form must reproduce the above copyright
10  notice, this list of conditions and the following disclaimer in the
11  documentation and/or other materials provided with the distribution.
12  * Neither the name of the tiny-dnn nor the
13  names of its contributors may be used to endorse or promote products
14  derived from this software without specific prior written permission.
15 
16  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
17  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
20  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27 #pragma once
28 #include <typeindex>
29 #include <map>
30 #include <functional>
31 #include <memory>
32 #include <string>
33 #include <cereal/archives/json.hpp>
34 #include <cereal/types/memory.hpp>
35 #include "tiny_dnn/util/nn_error.h"
36 #include "tiny_dnn/util/macro.h"
37 #include "tiny_dnn/layers/layers.h"
38 
39 namespace tiny_dnn {
40 
41 template <typename OutputArchive>
43 public:
44  void register_saver(const std::string& name, std::function<void(OutputArchive&, const layer*)> func) {
45  savers_[name] = [=](void* ar, const layer* l) {
46  return func(*reinterpret_cast<OutputArchive*>(ar), l);
47  };
48  }
49 
50  template <typename T>
51  void register_type(const std::string& name) {
52  type_names_[typeid(T)] = name;
53  }
54 
55  void save(const std::string& layer_name, OutputArchive & ar, const layer *l) {
56  check_if_enabled();
57 
58  if (savers_.find(layer_name) == savers_.end()) {
59  throw nn_error("Failed to generate layer. Generator for " + layer_name + " is not found.\n"
60  "Please use CNN_REGISTER_LAYER_DESERIALIZER macro to register appropriate generator");
61  }
62 
63  savers_[layer_name](reinterpret_cast<void*>(&ar), l);
64  }
65 
66  const std::string& type_name(std::type_index index) const {
67  if (type_names_.find(index) == type_names_.end()) {
68  throw nn_error("Typename is not registered");
69  }
70  return type_names_.at(index);
71  }
72 
73  static serialization_helper& get_instance() {
74  static serialization_helper instance;
75  return instance;
76  }
77 
78 private:
79  void check_if_enabled() const {
80 #ifdef CNN_NO_SERIALIZATION
81  static_assert(sizeof(OutputArchive)==0,
82  "You are using save functions, but serialization function is disabled in current configuration.\n\n"
83  "You need to undef CNN_NO_SERIALIZATION to enable these functions.\n"
84  "If you are using cmake, you can use -DUSE_SERIALIZER=ON option.\n\n");
85 #endif
86  }
87 
89  std::map<std::string, std::function<void(void*, const layer*)>> savers_;
90 
91  std::map<std::type_index, std::string> type_names_;
92 
93  template <typename T>
94  static void save_layer_impl(OutputArchive& oa, const layer* layer);
95 
96 #define CNN_REGISTER_LAYER_BODY(layer_type, layer_name) \
97  register_type<layer_type>(layer_name);\
98  register_saver(layer_name, save_layer_impl<layer_type>)
99 
100 #define CNN_REGISTER_LAYER(layer_type, layer_name) CNN_REGISTER_LAYER_BODY(layer_type, #layer_name)
101 
102 #define CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, activation_type, layer_name) \
103 CNN_REGISTER_LAYER_BODY(layer_type<activation::activation_type>, #layer_name "<" #activation_type ">")
104 
105 #define CNN_REGISTER_LAYER_WITH_ACTIVATIONS(layer_type, layer_name) \
106 CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, tan_h, layer_name); \
107 CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, softmax, layer_name); \
108 CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, identity, layer_name); \
109 CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, sigmoid, layer_name); \
110 CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, relu, layer_name); \
111 CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, leaky_relu, layer_name); \
112 CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, elu, layer_name); \
113 CNN_REGISTER_LAYER_WITH_ACTIVATION(layer_type, tan_hp1m2, layer_name)
114 
116 #include "serialization_layer_list.h"
117  }
118 
119 #undef CNN_REGISTER_LAYER_BODY
120 #undef CNN_REGISTER_LAYER
121 #undef CNN_REGISTER_LAYER_WITH_ACTIVATION
122 #undef CNN_REGISTER_LAYER_WITH_ACTIVATIONS
123 
124 }; // class serialization_helper
125 
126 template <typename OutputArchive>
127 template <typename T>
128 void serialization_helper<OutputArchive>::save_layer_impl(OutputArchive& oa, const layer* layer) {
129  oa (cereal::make_nvp(serialization_helper<OutputArchive>::get_instance().type_name(typeid(T)),
130  *dynamic_cast<const T*>(layer)));
131 }
132 
133 template <typename OutputArchive>
134 void layer::save_layer(OutputArchive & oa, const layer& l) {
135  const std::string& name = serialization_helper<OutputArchive>::get_instance().type_name(typeid(l));
136  serialization_helper<OutputArchive>::get_instance().save(name, oa, &l);
137 }
138 
139 template <class Archive>
140 void layer::serialize_prolog(Archive & ar) {
141  ar(cereal::make_nvp("type",
142  serialization_helper<Archive>::get_instance().type_name(typeid(*this))));
143 }
144 
145 } // namespace tiny_dnn
146 
base class of all kind of NN layers
Definition: layer.h:62
error exception class for tiny-dnn
Definition: nn_error.h:37
Definition: serialization_helper.h:42