positional_encoding.hpp

Go to the documentation of this file.

 
#ifndef MLPACK_METHODS_ANN_LAYER_POSITIONAL_ENCODING_HPP
#define MLPACK_METHODS_ANN_LAYER_POSITIONAL_ENCODING_HPP
 
#include <mlpack/prereqs.hpp>
 
namespace mlpack {
namespace ann  {
 
template <
    typename InputDataType = arma::mat,
    typename OutputDataType = arma::mat
>
class PositionalEncoding
{
 public:
  PositionalEncoding();
 
  PositionalEncoding(const size_t embedDim,
                     const size_t maxSequenceLength);
 
  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);
 
  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; }
 
  InputDataType const& Encoding() const { return positionalEncoding; }
 
  template<typename Archive>
  void serialize(Archive& ar, const unsigned int /* version */);
 
 private:
  void InitPositionalEncoding();
 
  size_t embedDim;
 
  size_t maxSequenceLength;
 
  InputDataType positionalEncoding;
 
  OutputDataType delta;
 
  InputDataType inputParameter;
 
  OutputDataType outputParameter;
}; // class PositionalEncoding
 
} // namespace ann
} // namespace mlpack
 
// Include implementation.
#include "positional_encoding_impl.hpp"
 
#endif