batch_norm.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_BATCHNORM_HPP
#define MLPACK_METHODS_ANN_LAYER_BATCHNORM_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace ann  {

template <
  typename InputDataType = arma::mat,
  typename OutputDataType = arma::mat
>
class BatchNorm
{
 public:
  BatchNorm();

  BatchNorm(const size_t size, const double eps = 1e-8);

  void Reset();

  template<typename eT>
  void Forward(const 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(const arma::Mat<eT>&& input,
                arma::Mat<eT>&& error,
                arma::Mat<eT>&& gradient);

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

  InputDataType const& InputParameter() const { return inputParameter; }
  InputDataType& InputParameter() { return inputParameter; }

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

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

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

  bool Deterministic() const { return deterministic; }
  bool& Deterministic() { return deterministic; }

  OutputDataType TrainingMean() { return stats.mean(); }

  OutputDataType TrainingVariance() { return stats.var(1); }

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

 private:
  size_t size;

  double eps;

  OutputDataType gamma;

  OutputDataType beta;

  OutputDataType weights;

  bool deterministic;

  OutputDataType mean;

  OutputDataType variance;

  arma::running_stat_vec<arma::colvec> stats;

  OutputDataType gradient;

  OutputDataType delta;

  InputDataType inputParameter;

  OutputDataType outputParameter;

  OutputDataType normalized;
}; // class BatchNorm

} // namespace ann
} // namespace mlpack

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

#endif