recurrent_impl.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_RECURRENT_IMPL_HPP
#define MLPACK_METHODS_ANN_LAYER_RECURRENT_IMPL_HPP

// In case it hasn't yet been included.
#include "recurrent.hpp"

#include "../visitor/add_visitor.hpp"
#include "../visitor/backward_visitor.hpp"
#include "../visitor/gradient_visitor.hpp"
#include "../visitor/gradient_zero_visitor.hpp"
#include "../visitor/input_shape_visitor.hpp"

namespace mlpack {
namespace ann  {

template<typename InputDataType, typename OutputDataType,
         typename... CustomLayers>
Recurrent<InputDataType, OutputDataType, CustomLayers...>::Recurrent() :
    rho(0),
    forwardStep(0),
    backwardStep(0),
    gradientStep(0),
    deterministic(false),
    ownsLayer(false)
{
  // Nothing to do.
}

template <typename InputDataType, typename OutputDataType,
          typename... CustomLayers>
template<
    typename StartModuleType,
    typename InputModuleType,
    typename FeedbackModuleType,
    typename TransferModuleType
>
Recurrent<InputDataType, OutputDataType, CustomLayers...>::Recurrent(
    const StartModuleType& start,
    const InputModuleType& input,
    const FeedbackModuleType& feedback,
    const TransferModuleType& transfer,
    const size_t rho) :
    startModule(new StartModuleType(start)),
    inputModule(new InputModuleType(input)),
    feedbackModule(new FeedbackModuleType(feedback)),
    transferModule(new TransferModuleType(transfer)),
    rho(rho),
    forwardStep(0),
    backwardStep(0),
    gradientStep(0),
    deterministic(false),
    ownsLayer(true)
{
  initialModule = new Sequential<>();
  mergeModule = new AddMerge<>(false, false, false);
  recurrentModule = new Sequential<>(false, false);

  boost::apply_visitor(AddVisitor<CustomLayers...>(inputModule),
                       initialModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(startModule),
                       initialModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(transferModule),
                       initialModule);

  boost::apply_visitor(AddVisitor<CustomLayers...>(inputModule), mergeModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(feedbackModule),
                       mergeModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(mergeModule),
                       recurrentModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(transferModule),
                       recurrentModule);

  network.push_back(initialModule);
  network.push_back(mergeModule);
  network.push_back(feedbackModule);
  network.push_back(recurrentModule);
}

template<typename InputDataType, typename OutputDataType,
         typename... CustomLayers>
Recurrent<InputDataType, OutputDataType, CustomLayers...>::Recurrent(
    const Recurrent& network) :
    rho(network.rho),
    forwardStep(network.forwardStep),
    backwardStep(network.backwardStep),
    gradientStep(network.gradientStep),
    deterministic(network.deterministic),
    ownsLayer(network.ownsLayer)
{
  startModule = boost::apply_visitor(copyVisitor, network.startModule);
  inputModule = boost::apply_visitor(copyVisitor, network.inputModule);
  feedbackModule = boost::apply_visitor(copyVisitor, network.feedbackModule);
  transferModule = boost::apply_visitor(copyVisitor, network.transferModule);
  initialModule = new Sequential<>();
  mergeModule = new AddMerge<>(false, false, false);
  recurrentModule = new Sequential<>(false, false);

  boost::apply_visitor(AddVisitor<CustomLayers...>(inputModule),
                       initialModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(startModule),
                       initialModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(transferModule),
                       initialModule);

  boost::apply_visitor(AddVisitor<CustomLayers...>(inputModule), mergeModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(feedbackModule),
                       mergeModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(mergeModule),
                       recurrentModule);
  boost::apply_visitor(AddVisitor<CustomLayers...>(transferModule),
                       recurrentModule);
  this->network.push_back(initialModule);
  this->network.push_back(mergeModule);
  this->network.push_back(feedbackModule);
  this->network.push_back(recurrentModule);
}

template<typename InputDataType, typename OutputDataType,
         typename... CustomLayers>
size_t
Recurrent<InputDataType, OutputDataType, CustomLayers...>::InputShape() const
{
  const size_t inputShapeStartModule = boost::apply_visitor(InShapeVisitor(),
      startModule);

  // Return the input shape of the first module that we have.
  if (inputShapeStartModule != 0)
  {
    return inputShapeStartModule;
  }
  // If input shape of first module is 0.
  else
  {
    // Return input shape of the second module that we have.
    const size_t inputShapeInputModule = boost::apply_visitor(InShapeVisitor(),
        inputModule);
    if (inputShapeInputModule != 0)
    {
      return inputShapeInputModule;
    }
    else // If the input shape of second module is 0.
    {
      // Return input shape of the third module that we have.
      const size_t inputShapeFeedbackModule = boost::apply_visitor(
          InShapeVisitor(), feedbackModule);
      if (inputShapeFeedbackModule != 0)
      {
        return inputShapeFeedbackModule;
      }
      else // If the input shape of the third module is 0.
      {
        // Return the shape of the fourth module that we have.
        const size_t inputShapeTransferModule = boost::apply_visitor(
            InShapeVisitor(), transferModule);
        if (inputShapeTransferModule != 0)
        {
          return inputShapeTransferModule;
        }
        else // If the input shape of the fourth module is 0.
        {
          return 0;
        }
      }
    }
  }
}

template<typename InputDataType, typename OutputDataType,
         typename... CustomLayers>
template<typename eT>
void Recurrent<InputDataType, OutputDataType, CustomLayers...>::Forward(
    const arma::Mat<eT>& input, arma::Mat<eT>& output)
{
  if (forwardStep == 0)
  {
    boost::apply_visitor(ForwardVisitor(input, output), initialModule);
  }
  else
  {
    boost::apply_visitor(ForwardVisitor(input,
        boost::apply_visitor(outputParameterVisitor, inputModule)),
        inputModule);

    boost::apply_visitor(ForwardVisitor(boost::apply_visitor(
        outputParameterVisitor, transferModule),
        boost::apply_visitor(outputParameterVisitor, feedbackModule)),
        feedbackModule);

    boost::apply_visitor(ForwardVisitor(input, output), recurrentModule);
  }

  output = boost::apply_visitor(outputParameterVisitor, transferModule);

  // Save the feedback output parameter when training the module.
  if (!deterministic)
  {
    feedbackOutputParameter.push_back(output);
  }

  forwardStep++;
  if (forwardStep == rho)
  {
    forwardStep = 0;
    backwardStep = 0;

    if (!recurrentError.is_empty())
    {
      recurrentError.zeros();
    }
  }
}

template<typename InputDataType, typename OutputDataType,
         typename... CustomLayers>
template<typename eT>
void Recurrent<InputDataType, OutputDataType, CustomLayers...>::Backward(
    const arma::Mat<eT>& /* input */, const arma::Mat<eT>& gy, arma::Mat<eT>& g)
{
  if (!recurrentError.is_empty())
  {
    recurrentError += gy;
  }
  else
  {
    recurrentError = gy;
  }

  if (backwardStep < (rho - 1))
  {
    boost::apply_visitor(BackwardVisitor(boost::apply_visitor(
        outputParameterVisitor, recurrentModule), recurrentError,
        boost::apply_visitor(deltaVisitor, recurrentModule)),
        recurrentModule);

    boost::apply_visitor(BackwardVisitor(boost::apply_visitor(
        outputParameterVisitor, inputModule),
        boost::apply_visitor(deltaVisitor, recurrentModule), g),
        inputModule);

    boost::apply_visitor(BackwardVisitor(boost::apply_visitor(
        outputParameterVisitor, feedbackModule),
        boost::apply_visitor(deltaVisitor, recurrentModule),
        boost::apply_visitor(deltaVisitor, feedbackModule)), feedbackModule);
  }
  else
  {
    boost::apply_visitor(BackwardVisitor(boost::apply_visitor(
        outputParameterVisitor, initialModule), recurrentError, g),
        initialModule);
  }

  recurrentError = boost::apply_visitor(deltaVisitor, feedbackModule);
  backwardStep++;
}

template<typename InputDataType, typename OutputDataType,
         typename... CustomLayers>
template<typename eT>
void Recurrent<InputDataType, OutputDataType, CustomLayers...>::Gradient(
    const arma::Mat<eT>& input,
    const arma::Mat<eT>& error,
    arma::Mat<eT>& /* gradient */)
{
  if (gradientStep < (rho - 1))
  {
    boost::apply_visitor(GradientVisitor(input, error), recurrentModule);

    boost::apply_visitor(GradientVisitor(input,
        boost::apply_visitor(deltaVisitor, mergeModule)), inputModule);

    boost::apply_visitor(GradientVisitor(
        feedbackOutputParameter[feedbackOutputParameter.size() - 2 -
        gradientStep], boost::apply_visitor(deltaVisitor,
        mergeModule)), feedbackModule);
  }
  else
  {
    boost::apply_visitor(GradientZeroVisitor(), recurrentModule);
    boost::apply_visitor(GradientZeroVisitor(), inputModule);
    boost::apply_visitor(GradientZeroVisitor(), feedbackModule);

    boost::apply_visitor(GradientVisitor(input,
        boost::apply_visitor(deltaVisitor, startModule)), initialModule);
  }

  gradientStep++;
  if (gradientStep == rho)
  {
    gradientStep = 0;
    feedbackOutputParameter.clear();
  }
}

template<typename InputDataType, typename OutputDataType,
         typename... CustomLayers>
template<typename Archive>
void Recurrent<InputDataType, OutputDataType, CustomLayers...>::serialize(
    Archive& ar, const uint32_t /* version */)
{
  // Clean up memory, if we are loading.
  if (cereal::is_loading<Archive>())
  {
    // Clear old things, if needed.
    boost::apply_visitor(DeleteVisitor(), recurrentModule);
    boost::apply_visitor(DeleteVisitor(), initialModule);
    boost::apply_visitor(DeleteVisitor(), startModule);
    network.clear();
  }

  ar(CEREAL_VARIANT_POINTER(startModule));
  ar(CEREAL_VARIANT_POINTER(inputModule));
  ar(CEREAL_VARIANT_POINTER(feedbackModule));
  ar(CEREAL_VARIANT_POINTER(transferModule));
  ar(CEREAL_NVP(rho));
  ar(CEREAL_NVP(ownsLayer));

  // Set up the network.
  if (cereal::is_loading<Archive>())
  {
    initialModule = new Sequential<>();
    mergeModule = new AddMerge<>(false, false, false);
    recurrentModule = new Sequential<>(false, false);

    boost::apply_visitor(AddVisitor<CustomLayers...>(inputModule),
                         initialModule);
    boost::apply_visitor(AddVisitor<CustomLayers...>(startModule),
                         initialModule);
    boost::apply_visitor(AddVisitor<CustomLayers...>(transferModule),
                         initialModule);

    boost::apply_visitor(AddVisitor<CustomLayers...>(inputModule),
                         mergeModule);
    boost::apply_visitor(AddVisitor<CustomLayers...>(feedbackModule),
                         mergeModule);
    boost::apply_visitor(AddVisitor<CustomLayers...>(mergeModule),
                         recurrentModule);
    boost::apply_visitor(AddVisitor<CustomLayers...>(transferModule),
                         recurrentModule);

    network.push_back(initialModule);
    network.push_back(mergeModule);
    network.push_back(feedbackModule);
    network.push_back(recurrentModule);
  }
}

} // namespace ann
} // namespace mlpack

#endif