mlpack 3.4.2
positional_encoding.hpp
Go to the documentation of this file.
1
12#ifndef MLPACK_METHODS_ANN_LAYER_POSITIONAL_ENCODING_HPP
13#define MLPACK_METHODS_ANN_LAYER_POSITIONAL_ENCODING_HPP
14
15#include <mlpack/prereqs.hpp>
16
17namespace mlpack {
18namespace ann {
19
33template <
34 typename InputDataType = arma::mat,
35 typename OutputDataType = arma::mat
36>
38{
39 public:
44
51 PositionalEncoding(const size_t embedDim,
52 const size_t maxSequenceLength);
53
61 template<typename eT>
62 void Forward(const arma::Mat<eT>& input, arma::Mat<eT>& output);
63
73 template<typename eT>
74 void Backward(const arma::Mat<eT>& /* input */,
75 const arma::Mat<eT>& gy,
76 arma::Mat<eT>& g);
77
79 InputDataType const& InputParameter() const { return inputParameter; }
81 InputDataType& InputParameter() { return inputParameter; }
82
84 OutputDataType const& OutputParameter() const { return outputParameter; }
86 OutputDataType& OutputParameter() { return outputParameter; }
87
89 OutputDataType const& Delta() const { return delta; }
91 OutputDataType& Delta() { return delta; }
92
94 InputDataType const& Encoding() const { return positionalEncoding; }
95
99 template<typename Archive>
100 void serialize(Archive& ar, const unsigned int /* version */);
101
102 private:
106 void InitPositionalEncoding();
107
109 size_t embedDim;
110
112 size_t maxSequenceLength;
113
115 InputDataType positionalEncoding;
116
118 OutputDataType delta;
119
121 InputDataType inputParameter;
122
124 OutputDataType outputParameter;
125}; // class PositionalEncoding
126
127} // namespace ann
128} // namespace mlpack
129
130// Include implementation.
131#include "positional_encoding_impl.hpp"
132
133#endif
Positional Encoding injects some information about the relative or absolute position of the tokens in...
OutputDataType const & Delta() const
Get the delta.
void Forward(const arma::Mat< eT > &input, arma::Mat< eT > &output)
Ordinary feed forward pass of a neural network, evaluating the function f(x) by propagating the activ...
InputDataType & InputParameter()
Modify the input parameter.
OutputDataType const & OutputParameter() const
Get the output parameter.
InputDataType const & Encoding() const
Get the positional encoding vector.
InputDataType const & InputParameter() const
Get the input parameter.
PositionalEncoding(const size_t embedDim, const size_t maxSequenceLength)
Create the PositionalEncoding layer object using the specified parameters.
void Backward(const arma::Mat< eT > &, const arma::Mat< eT > &gy, arma::Mat< eT > &g)
Ordinary feed backward pass of a neural network, calculating the function f(x) by propagating x backw...
OutputDataType & OutputParameter()
Modify the output parameter.
void serialize(Archive &ar, const unsigned int)
Serialize the layer.
OutputDataType & Delta()
Modify the delta.
PositionalEncoding()
Create PositionalEncoding object.
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: cv.hpp:1
The core includes that mlpack expects; standard C++ includes and Armadillo.