mlpack
base_layer.hpp
Go to the documentation of this file.
1 
13 #ifndef MLPACK_METHODS_ANN_LAYER_BASE_LAYER_HPP
14 #define MLPACK_METHODS_ANN_LAYER_BASE_LAYER_HPP
15 
16 #include <mlpack/prereqs.hpp>
17 #include <mlpack/methods/ann/activation_functions/logistic_function.hpp>
18 #include <mlpack/methods/ann/activation_functions/identity_function.hpp>
19 #include <mlpack/methods/ann/activation_functions/rectifier_function.hpp>
20 #include <mlpack/methods/ann/activation_functions/tanh_function.hpp>
21 #include <mlpack/methods/ann/activation_functions/softplus_function.hpp>
22 #include <mlpack/methods/ann/activation_functions/hard_sigmoid_function.hpp>
23 #include <mlpack/methods/ann/activation_functions/swish_function.hpp>
24 #include <mlpack/methods/ann/activation_functions/mish_function.hpp>
25 #include <mlpack/methods/ann/activation_functions/lisht_function.hpp>
26 #include <mlpack/methods/ann/activation_functions/gelu_function.hpp>
27 #include <mlpack/methods/ann/activation_functions/elliot_function.hpp>
28 #include <mlpack/methods/ann/activation_functions/elish_function.hpp>
29 #include <mlpack/methods/ann/activation_functions/gaussian_function.hpp>
30 
31 namespace mlpack {
32 namespace ann {
33 
60 template <
61  class ActivationFunction = LogisticFunction,
62  typename InputDataType = arma::mat,
63  typename OutputDataType = arma::mat
64 >
65 class BaseLayer
66 {
67  public:
71  BaseLayer()
72  {
73  // Nothing to do here.
74  }
75 
83  template<typename InputType, typename OutputType>
84  void Forward(const InputType& input, OutputType& output)
85  {
86  ActivationFunction::Fn(input, output);
87  }
88 
98  template<typename eT>
99  void Backward(const arma::Mat& input,
100  const arma::Mat& gy,
101  arma::Mat& g)
102  {
103  arma::Mat derivative;
104  ActivationFunction::Deriv(input, derivative);
105  g = gy % derivative;
106  }
107 
109  OutputDataType const& OutputParameter() const { return outputParameter; }
111  OutputDataType& OutputParameter() { return outputParameter; }
112 
114  OutputDataType const& Delta() const { return delta; }
116  OutputDataType& Delta() { return delta; }
117 
121  template<typename Archive>
122  void serialize(Archive& /* ar */, const unsigned int /* version */)
123  {
124  /* Nothing to do here */
125  }
126 
127  private:
129  OutputDataType delta;
130 
132  OutputDataType outputParameter;
133 }; // class BaseLayer
134 
135 // Convenience typedefs.
136 
140 template <
141  class ActivationFunction = LogisticFunction,
142  typename InputDataType = arma::mat,
143  typename OutputDataType = arma::mat
144 >
145 using SigmoidLayer = BaseLayer<
146  ActivationFunction, InputDataType, OutputDataType>;
147 
151 template <
152  class ActivationFunction = IdentityFunction,
153  typename InputDataType = arma::mat,
154  typename OutputDataType = arma::mat
155 >
156 using IdentityLayer = BaseLayer<
157  ActivationFunction, InputDataType, OutputDataType>;
158 
162 template <
163  class ActivationFunction = RectifierFunction,
164  typename InputDataType = arma::mat,
165  typename OutputDataType = arma::mat
166 >
167 using ReLULayer = BaseLayer<
168  ActivationFunction, InputDataType, OutputDataType>;
169 
173 template <
174  class ActivationFunction = TanhFunction,
175  typename InputDataType = arma::mat,
176  typename OutputDataType = arma::mat
177 >
178 using TanHLayer = BaseLayer<
179  ActivationFunction, InputDataType, OutputDataType>;
180 
184 template <
185  class ActivationFunction = SoftplusFunction,
186  typename InputDataType = arma::mat,
187  typename OutputDataType = arma::mat
188 >
189 using SoftPlusLayer = BaseLayer<
190  ActivationFunction, InputDataType, OutputDataType>;
191 
195 template <
196  class ActivationFunction = HardSigmoidFunction,
197  typename InputDataType = arma::mat,
198  typename OutputDataType = arma::mat
199 >
200 using HardSigmoidLayer = BaseLayer<
201  ActivationFunction, InputDataType, OutputDataType>;
202 
206 template <
207  class ActivationFunction = SwishFunction,
208  typename InputDataType = arma::mat,
209  typename OutputDataType = arma::mat
210 >
211 using SwishFunctionLayer = BaseLayer<
212  ActivationFunction, InputDataType, OutputDataType>;
213 
217 template <
218  class ActivationFunction = MishFunction,
219  typename InputDataType = arma::mat,
220  typename OutputDataType = arma::mat
221 >
222 using MishFunctionLayer = BaseLayer<
223  ActivationFunction, InputDataType, OutputDataType>;
224 
228 template <
229  class ActivationFunction = LiSHTFunction,
230  typename InputDataType = arma::mat,
231  typename OutputDataType = arma::mat
232 >
233 using LiSHTFunctionLayer = BaseLayer<
234  ActivationFunction, InputDataType, OutputDataType>;
235 
239 template <
240  class ActivationFunction = GELUFunction,
241  typename InputDataType = arma::mat,
242  typename OutputDataType = arma::mat
243 >
244 using GELUFunctionLayer = BaseLayer<
245  ActivationFunction, InputDataType, OutputDataType>;
246 
250 template <
251  class ActivationFunction = ElliotFunction,
252  typename InputDataType = arma::mat,
253  typename OutputDataType = arma::mat
254 >
255 using ElliotFunctionLayer = BaseLayer<
256  ActivationFunction, InputDataType, OutputDataType>;
257 
261 template <
262  class ActivationFunction = ElishFunction,
263  typename InputDataType = arma::mat,
264  typename OutputDataType = arma::mat
265 >
266 using ElishFunctionLayer = BaseLayer<
267  ActivationFunction, InputDataType, OutputDataType>;
268 
272 template <
273  class ActivationFunction = GaussianFunction,
274  typename InputDataType = arma::mat,
275  typename OutputDataType = arma::mat
276 >
277 using GaussianFunctionLayer = BaseLayer<
278  ActivationFunction, InputDataType, OutputDataType>;
279 
280 } // namespace ann
281 } // namespace mlpack
282 
283 #endif
mlpack::ann::IdentityFunction
The identity function, defined by.
Definition: identity_function.hpp:28
mlpack::ann::BaseLayer::Forward
void Forward(const InputType &input, OutputType &output)
Ordinary feed forward pass of a neural network, evaluating the function f(x) by propagating the activ...
Definition: base_layer.hpp:84
swish_function.hpp
mlpack::ann::BaseLayer::OutputParameter
OutputDataType & OutputParameter()
Modify the output parameter.
Definition: base_layer.hpp:111
mlpack::ann::BaseLayer::BaseLayer
BaseLayer()
Create the BaseLayer object.
Definition: base_layer.hpp:71
elliot_function.hpp
mlpack::ann::LiSHTFunction
The LiSHT function, defined by.
Definition: lisht_function.hpp:42
identity_function.hpp
mlpack::ann::BaseLayer::Delta
OutputDataType & Delta()
Modify the delta.
Definition: base_layer.hpp:116
softplus_function.hpp
lisht_function.hpp
mlpack::ann::BaseLayer::Backward
void Backward(const arma::Mat< eT > &input, const arma::Mat< eT > &gy, arma::Mat< eT > &g)
Ordinary feed backward pass of a neural network, calculating the function f(x) by propagating x backw...
Definition: base_layer.hpp:99
mish_function.hpp
mlpack::ann::BaseLayer::serialize
void serialize(Archive &, const unsigned int)
Serialize the layer.
Definition: base_layer.hpp:122
mlpack::ann::TanhFunction
The tanh function, defined by.
Definition: tanh_function.hpp:29
mlpack
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: add_to_cli11.hpp:21
logistic_function.hpp
prereqs.hpp
The core includes that mlpack expects; standard C++ includes and Armadillo.
mlpack::ann::ElishFunction
The ELiSH function, defined by.
Definition: elish_function.hpp:48
hard_sigmoid_function.hpp
mlpack::ann::BaseLayer::OutputParameter
OutputDataType const & OutputParameter() const
Get the output parameter.
Definition: base_layer.hpp:109
mlpack::ann::BaseLayer::Delta
OutputDataType const & Delta() const
Get the delta.
Definition: base_layer.hpp:114
mlpack::ann::BaseLayer
Implementation of the base layer.
Definition: base_layer.hpp:65
rectifier_function.hpp
mlpack::ann::MishFunction
The Mish function, defined by.
Definition: mish_function.hpp:40
mlpack::ann::LogisticFunction
The logistic function, defined by.
Definition: logistic_function.hpp:29
gaussian_function.hpp
mlpack::ann::GaussianFunction
The gaussian function, defined by.
Definition: gaussian_function.hpp:28
mlpack::ann::ElliotFunction
The Elliot function, defined by.
Definition: elliot_function.hpp:40
mlpack::ann::SwishFunction
The swish function, defined by.
Definition: swish_function.hpp:30
mlpack::ann::SoftplusFunction
The softplus function, defined by.
Definition: softplus_function.hpp:43
gelu_function.hpp
elish_function.hpp
mlpack::ann::HardSigmoidFunction
The hard sigmoid function, defined by.
Definition: hard_sigmoid_function.hpp:34
mlpack::ann::GELUFunction
The GELU function, defined by.
Definition: gelu_function.hpp:31
tanh_function.hpp
mlpack::ann::RectifierFunction
The rectifier function, defined by.
Definition: rectifier_function.hpp:45