brnn.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_BRNN_HPP
#define MLPACK_METHODS_ANN_BRNN_HPP

#include <mlpack/prereqs.hpp>

#include "visitor/delete_visitor.hpp"
#include "visitor/delta_visitor.hpp"
#include "visitor/copy_visitor.hpp"
#include "visitor/output_parameter_visitor.hpp"
#include "visitor/reset_visitor.hpp"

#include "init_rules/network_init.hpp"
#include <mlpack/methods/ann/layer/layer_types.hpp>
#include <mlpack/methods/ann/layer/layer.hpp>
#include <mlpack/methods/ann/layer/layer_traits.hpp>
#include <mlpack/methods/ann/init_rules/random_init.hpp>

#include <ensmallen.hpp>

namespace mlpack {
namespace ann  {

template<
  typename OutputLayerType = NegativeLogLikelihood<>,
  typename MergeLayerType = Concat<>,
  typename MergeOutputType = LogSoftMax<>,
  typename InitializationRuleType = RandomInitialization,
  typename... CustomLayers
>
class BRNN
{
 public:
  using NetworkType = BRNN<OutputLayerType,
                           MergeLayerType,
                           MergeOutputType,
                           InitializationRuleType,
                           CustomLayers...>;

  BRNN(const size_t rho,
       const bool single = false,
       OutputLayerType outputLayer = OutputLayerType(),
       MergeLayerType* mergeLayer = new MergeLayerType(),
       MergeOutputType* mergeOutput = new MergeOutputType(),
       InitializationRuleType initializeRule = InitializationRuleType());

  ~BRNN();

  template<typename OptimizerType>
  typename std::enable_if<
      HasMaxIterations<OptimizerType, size_t&(OptimizerType::*)()>
      ::value, void>::type
  WarnMessageMaxIterations(OptimizerType& optimizer, size_t samples) const;

  template<typename OptimizerType>
  typename std::enable_if<
      !HasMaxIterations<OptimizerType, size_t&(OptimizerType::*)()>
      ::value, void>::type
  WarnMessageMaxIterations(OptimizerType& optimizer, size_t samples) const;

  template<typename OptimizerType>
  double Train(arma::cube predictors,
               arma::cube responses,
               OptimizerType& optimizer);

  template<typename OptimizerType = ens::StandardSGD>
  double Train(arma::cube predictors, arma::cube responses);

  void Predict(arma::cube predictors,
               arma::cube& results,
               const size_t batchSize = 256);

  double Evaluate(const arma::mat& parameters,
                  const size_t begin,
                  const size_t batchSize,
                  const bool deterministic);

  double Evaluate(const arma::mat& parameters,
                  const size_t begin,
                  const size_t batchSize);

  template<typename GradType>
  double EvaluateWithGradient(const arma::mat& parameters,
                              const size_t begin,
                              GradType& gradient,
                              const size_t batchSize);

  void Gradient(const arma::mat& parameters,
                const size_t begin,
                arma::mat& gradient,
                const size_t batchSize);

  void Shuffle();

  /*
   * Add a new module to the model.
   *
   * @param args The layer parameter.
   */
  template <class LayerType, class... Args>
  void Add(Args... args);

  /*
   * Add a new module to the model.
   *
   * @param layer The Layer to be added to the model.
   */
  void Add(LayerTypes<CustomLayers...> layer);

  size_t NumFunctions() const { return numFunctions; }

  const arma::mat& Parameters() const { return parameter; }
  arma::mat& Parameters() { return parameter; }

  const size_t& Rho() const { return rho; }
  size_t& Rho() { return rho; }

  const arma::cube& Responses() const { return responses; }
  arma::cube& Responses() { return responses; }

  const arma::cube& Predictors() const { return predictors; }
  arma::cube& Predictors() { return predictors; }

  void Reset();

  void ResetParameters();

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

 private:
  // Helper functions.
  void ResetDeterministic();

  size_t rho;

  OutputLayerType outputLayer;

  LayerTypes<CustomLayers...> mergeLayer;

  LayerTypes<CustomLayers...> mergeOutput;

  InitializationRuleType initializeRule;

  size_t inputSize;

  size_t outputSize;

  size_t targetSize;

  bool reset;

  bool single;

  arma::cube predictors;

  arma::cube responses;

  arma::mat parameter;

  size_t numFunctions;

  arma::mat error;

  DeltaVisitor deltaVisitor;

  OutputParameterVisitor outputParameterVisitor;

  std::vector<arma::mat> forwardRNNOutputParameter;

  std::vector<arma::mat> backwardRNNOutputParameter;

  WeightSizeVisitor weightSizeVisitor;

  ResetVisitor resetVisitor;

  DeleteVisitor deleteVisitor;

  CopyVisitor<CustomLayers...> copyVisitor;

  bool deterministic;

  arma::mat forwardGradient;

  arma::mat backwardGradient;

  arma::mat totalGradient;

  RNN<OutputLayerType, InitializationRuleType, CustomLayers...> forwardRNN;

  RNN<OutputLayerType, InitializationRuleType, CustomLayers...> backwardRNN;
}; // class BRNN

} // namespace ann
} // namespace mlpack

namespace boost {
namespace serialization {

template<typename OutputLayerType,
         typename InitializationRuleType,
         typename MergeLayerType,
         typename MergeOutputType,
         typename... CustomLayer>
struct version<
    mlpack::ann::BRNN<OutputLayerType, MergeLayerType, MergeOutputType,
        InitializationRuleType, CustomLayer...>>
{
  BOOST_STATIC_CONSTANT(int, value = 1);
};

} // namespace serialization
} // namespace boost

// Include implementation.
#include "brnn_impl.hpp"

#endif