transposed_convolution.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_TRANSPOSED_CONVOLUTION_HPP
#define MLPACK_METHODS_ANN_LAYER_TRANSPOSED_CONVOLUTION_HPP

#include <mlpack/prereqs.hpp>

#include <mlpack/methods/ann/convolution_rules/border_modes.hpp>
#include <mlpack/methods/ann/convolution_rules/naive_convolution.hpp>
#include <mlpack/methods/ann/convolution_rules/fft_convolution.hpp>
#include <mlpack/methods/ann/convolution_rules/svd_convolution.hpp>
#include <mlpack/core/util/to_lower.hpp>

#include "layer_types.hpp"
#include "padding.hpp"

namespace mlpack {
namespace ann  {

template <
    typename ForwardConvolutionRule = NaiveConvolution<ValidConvolution>,
    typename BackwardConvolutionRule = NaiveConvolution<ValidConvolution>,
    typename GradientConvolutionRule = NaiveConvolution<ValidConvolution>,
    typename InputDataType = arma::mat,
    typename OutputDataType = arma::mat
>
class TransposedConvolution
{
 public:
  TransposedConvolution();

  TransposedConvolution(const size_t inSize,
                        const size_t outSize,
                        const size_t kernelWidth,
                        const size_t kernelHeight,
                        const size_t strideWidth = 1,
                        const size_t strideHeight = 1,
                        const size_t padW = 0,
                        const size_t padH = 0,
                        const size_t inputWidth = 0,
                        const size_t inputHeight = 0,
                        const size_t outputWidth = 0,
                        const size_t outputHeight = 0,
                        const std::string& paddingType = "None");

  TransposedConvolution(const size_t inSize,
                        const size_t outSize,
                        const size_t kernelWidth,
                        const size_t kernelHeight,
                        const size_t strideWidth,
                        const size_t strideHeight,
                        const std::tuple<size_t, size_t>& padW,
                        const std::tuple<size_t, size_t>& padH,
                        const size_t inputWidth = 0,
                        const size_t inputHeight = 0,
                        const size_t outputWidth = 0,
                        const size_t outputHeight = 0,
                        const std::string& paddingType = "None");

  /*
   * Set the weight and bias term.
   */
  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 */,
                const arma::Mat<eT>& gy,
                arma::Mat<eT>& g);

  /*
   * Calculate the gradient using the output delta and the input activation.
   *
   * @param * (input) The input parameter used for calculating the gradient.
   * @param error The calculated error.
   * @param gradient The calculated gradient.
   */
  template<typename eT>
  void Gradient(const arma::Mat<eT>& /* input */,
                const 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; }

  size_t const& InputWidth() const { return inputWidth; }
  size_t& InputWidth() { return inputWidth; }

  size_t const& InputHeight() const { return inputHeight; }
  size_t& InputHeight() { return inputHeight; }

  size_t const& OutputWidth() const { return outputWidth; }
  size_t& OutputWidth() { return outputWidth; }

  size_t const& OutputHeight() const { return outputHeight; }
  size_t& OutputHeight() { return outputHeight; }

  size_t InputSize() const { return inSize; }

  size_t OutputSize() const { return outSize; }

  size_t KernelWidth() const { return kernelWidth; }
  size_t& KernelWidth() { return kernelWidth; }

  size_t KernelHeight() const { return kernelHeight; }
  size_t& KernelHeight() { return kernelHeight; }

  size_t StrideWidth() const { return strideWidth; }
  size_t& StrideWidth() { return strideWidth; }

  size_t StrideHeight() const { return strideHeight; }
  size_t& StrideHeight() { return strideHeight; }

  size_t PadHTop() const { return padHTop; }
  size_t& PadHTop() { return padHTop; }

  size_t PadHBottom() const { return padHBottom; }
  size_t& PadHBottom() { return padHBottom; }

  size_t PadWLeft() const { return padWLeft; }
  size_t& PadWLeft() { return padWLeft; }

  size_t PadWRight() const { return padWRight; }
  size_t& PadWRight() { return padWRight; }

  arma::mat& Bias() { return bias; }

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

 private:
  /*
   * Rotates a 3rd-order tensor counterclockwise by 180 degrees.
   *
   * @param input The input data to be rotated.
   * @param output The rotated output.
   */
  template<typename eT>
  void Rotate180(const arma::Cube<eT>& input, arma::Cube<eT>& output)
  {
    output = arma::Cube<eT>(input.n_rows, input.n_cols, input.n_slices);

    // * left-right flip, up-down flip */
    for (size_t s = 0; s < output.n_slices; s++)
      output.slice(s) = arma::fliplr(arma::flipud(input.slice(s)));
  }

  /*
   * Function to assign padding such that output size is same as input size.
   */
  void InitializeSamePadding();

  /*
   * Rotates a dense matrix counterclockwise by 180 degrees.
   *
   * @param input The input data to be rotated.
   * @param output The rotated output.
   */
  template<typename eT>
  void Rotate180(const arma::Mat<eT>& input, arma::Mat<eT>& output)
  {
    // * left-right flip, up-down flip */
    output = arma::fliplr(arma::flipud(input));
  }


  /*
   * Insert zeros between the units of the given input data.
   * Note: This function should be used before using padding layer.
   *
   * @param input The input to be padded.
   * @param strideWidth Stride of filter application in the x direction.
   * @param strideHeight Stride of filter application in the y direction.
   * @param output The padded output data.
   */
  template<typename eT>
  void InsertZeros(const arma::Mat<eT>& input,
                   const size_t strideWidth,
                   const size_t strideHeight,
                   arma::Mat<eT>& output)
  {
    if (output.n_rows != input.n_rows * strideWidth - strideWidth + 1 ||
        output.n_cols != input.n_cols * strideHeight - strideHeight + 1)
    {
      output = arma::zeros(input.n_rows * strideWidth - strideWidth + 1,
          input.n_cols * strideHeight - strideHeight + 1);
    }

    for (size_t i = 0; i < output.n_rows; i += strideHeight)
    {
      for (size_t j = 0; j < output.n_cols; j += strideWidth)
      {
        // TODO: Use [] instead of () for speedup after this is completely
        // debugged and approved.
        output(i, j) = input(i / strideHeight, j / strideWidth);
      }
    }
  }

  /*
   * Insert zeros between the units of the given input data.
   * Note: This function should be used before using padding layer.
   *
   * @param input The input to be padded.
   * @param strideWidth Stride of filter application in the x direction.
   * @param strideHeight Stride of filter application in the y direction.
   * @param output The padded output data.
   */
  template<typename eT>
  void InsertZeros(const arma::Cube<eT>& input,
                   const size_t strideWidth,
                   const size_t strideHeight,
                   arma::Cube<eT>& output)
  {
    output = arma::zeros(input.n_rows * strideWidth - strideWidth + 1,
        input.n_cols * strideHeight - strideHeight + 1, input.n_slices);

    for (size_t i = 0; i < input.n_slices; ++i)
    {
      InsertZeros<eT>(input.slice(i), strideWidth, strideHeight,
          output.slice(i));
    }
  }

  size_t inSize;

  size_t outSize;

  size_t batchSize;

  size_t kernelWidth;

  size_t kernelHeight;

  size_t strideWidth;

  size_t strideHeight;

  size_t padWLeft;

  size_t padWRight;

  size_t padHBottom;

  size_t padHTop;

  size_t aW;

  size_t aH;

  OutputDataType weights;

  arma::cube weight;

  arma::mat bias;

  size_t inputWidth;

  size_t inputHeight;

  size_t outputWidth;

  size_t outputHeight;

  arma::cube outputTemp;

  arma::cube inputPaddedTemp;

  arma::cube inputExpandedTemp;

  arma::cube gTemp;

  arma::cube gradientTemp;

  ann::Padding<> paddingForward;

  ann::Padding<> paddingBackward;

  OutputDataType delta;

  OutputDataType gradient;

  InputDataType inputParameter;

  OutputDataType outputParameter;
}; // class TransposedConvolution

} // namespace ann
} // namespace mlpack

namespace boost {
namespace serialization {

template<
    typename ForwardConvolutionRule,
    typename BackwardConvolutionRule,
    typename GradientConvolutionRule,
    typename InputDataType,
    typename OutputDataType
>
struct version<
    mlpack::ann::TransposedConvolution<ForwardConvolutionRule,
        BackwardConvolutionRule, GradientConvolutionRule, InputDataType,
        OutputDataType> >
{
  BOOST_STATIC_CONSTANT(int, value = 1);
};

} // namespace serialization
} // namespace boost

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

#endif