weight_norm.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_WEIGHTNORM_HPP
#define MLPACK_METHODS_ANN_LAYER_WEIGHTNORM_HPP

#include <mlpack/prereqs.hpp>
#include "layer_types.hpp"

#include "../visitor/delete_visitor.hpp"
#include "../visitor/delta_visitor.hpp"
#include "../visitor/output_parameter_visitor.hpp"
#include "../visitor/reset_visitor.hpp"
#include "../visitor/weight_size_visitor.hpp"
#include "../visitor/weight_set_visitor.hpp"

namespace mlpack {
namespace ann  {

template <
  typename InputDataType = arma::mat,
  typename OutputDataType = arma::mat,
  typename... CustomLayers
>
class WeightNorm
{
 public:
  WeightNorm(LayerTypes<CustomLayers...> layer = LayerTypes<CustomLayers...>());

  ~WeightNorm();

  void Reset();

  template<typename eT>
  void Forward(arma::Mat<eT>&& input, arma::Mat<eT>&& output);

  template<typename eT>
  void Backward(const arma::Mat<eT>&& input,
                arma::Mat<eT>&& gy,
                arma::Mat<eT>&& g);

  template<typename eT>
  void Gradient(arma::Mat<eT>&& input,
                arma::Mat<eT>&& error,
                arma::Mat<eT>&& gradient);

  OutputDataType const& Delta() const { return delta; }
  OutputDataType& Delta() { return delta; }

  OutputDataType const& Gradient() const { return gradient; }
  OutputDataType& Gradient() { return gradient; }

  OutputDataType const& OutputParameter() const { return outputParameter; }
  OutputDataType& OutputParameter() { return outputParameter; }

  OutputDataType const& Parameters() const { return weights; }
  OutputDataType& Parameters() { return weights; }

  LayerTypes<CustomLayers...> const& Layer() { return wrappedLayer; }

  template<typename Archive>
  void serialize(Archive& ar, const unsigned int /* version */);

 private:
  size_t biasWeightSize;

  DeleteVisitor deleteVisitor;

  OutputDataType delta;

  DeltaVisitor deltaVisitor;

  OutputDataType gradient;

  LayerTypes<CustomLayers...> wrappedLayer;

  size_t layerWeightSize;

  OutputDataType outputParameter;

  OutputParameterVisitor outputParameterVisitor;

  void ResetGradients(arma::mat& gradient);

  ResetVisitor resetVisitor;

  OutputDataType scalarParameter;

  OutputDataType vectorParameter;

  OutputDataType weights;

  WeightSizeVisitor weightSizeVisitor;

  OutputDataType layerGradients;

  OutputDataType layerWeights;
}; // class WeightNorm

} // namespace ann
} // namespace mlpack

// Include the implementation.
#include "weight_norm_impl.hpp"

#endif