Dropout< InputDataType, OutputDataType > Class Template Reference

The dropout layer is a regularizer that randomly with probability 'ratio' sets input values to zero and scales the remaining elements by factor 1 / (1 - ratio) rather than during test time so as to keep the expected sum same. More...

Public Member Functions

 Dropout (const double ratio=0.5)
 Create the Dropout object using the specified ratio parameter. More...

 
 Dropout (const Dropout &layer)
 Copy Constructor. More...

 
 Dropout (const Dropout &&)
 Move Constructor. More...

 
template
<
typename
eT
>
void Backward (const arma::Mat< eT > &, const arma::Mat< eT > &gy, arma::Mat< eT > &g)
 Ordinary feed backward pass of the dropout layer. More...

 
OutputDataType const & Delta () const
 Get the detla. More...

 
OutputDataType & Delta ()
 Modify the delta. More...

 
bool Deterministic () const
 The value of the deterministic parameter. More...

 
bool & Deterministic ()
 Modify the value of the deterministic parameter. More...

 
template
<
typename
eT
>
void Forward (const arma::Mat< eT > &input, arma::Mat< eT > &output)
 Ordinary feed forward pass of the dropout layer. More...

 
Dropoutoperator= (const Dropout &layer)
 Copy assignment operator. More...

 
Dropoutoperator= (Dropout &&layer)
 Move assignment operator. More...

 
OutputDataType const & OutputParameter () const
 Get the output parameter. More...

 
OutputDataType & OutputParameter ()
 Modify the output parameter. More...

 
double Ratio () const
 The probability of setting a value to zero. More...

 
void Ratio (const double r)
 Modify the probability of setting a value to zero. More...

 
template
<
typename
Archive
>
void serialize (Archive &ar, const uint32_t)
 Serialize the layer. More...

 

Detailed Description


template
<
typename
InputDataType
=
arma::mat
,
typename
OutputDataType
=
arma::mat
>

class mlpack::ann::Dropout< InputDataType, OutputDataType >

The dropout layer is a regularizer that randomly with probability 'ratio' sets input values to zero and scales the remaining elements by factor 1 / (1 - ratio) rather than during test time so as to keep the expected sum same.

In the deterministic mode (during testing), there is no change in the input.

Note: During training you should set deterministic to false and during testing you should set deterministic to true.

For more information, see the following.

@article{Hinton2012,
author = {Geoffrey E. Hinton, Nitish Srivastava, Alex Krizhevsky,
Ilya Sutskever, Ruslan Salakhutdinov},
title = {Improving neural networks by preventing co-adaptation of feature
detectors},
journal = {CoRR},
volume = {abs/1207.0580},
year = {2012},
url = {https://arxiv.org/abs/1207.0580}
}
Template Parameters
InputDataTypeType of the input data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).
OutputDataTypeType of the output data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).

Definition at line 53 of file dropout.hpp.

Constructor & Destructor Documentation

◆ Dropout() [1/3]

Dropout ( const double  ratio = 0.5)

Create the Dropout object using the specified ratio parameter.

Parameters
ratioThe probability of setting a value to zero.

◆ Dropout() [2/3]

Dropout ( const Dropout< InputDataType, OutputDataType > &  layer)

Copy Constructor.

◆ Dropout() [3/3]

Dropout ( const Dropout< InputDataType, OutputDataType > &&  )

Move Constructor.

Member Function Documentation

◆ Backward()

void Backward ( const arma::Mat< eT > &  ,
const arma::Mat< eT > &  gy,
arma::Mat< eT > &  g 
)

Ordinary feed backward pass of the dropout layer.

Parameters
*(input) The propagated input activation.
gyThe backpropagated error.
gThe calculated gradient.

◆ Delta() [1/2]

OutputDataType const& Delta ( ) const
inline

Get the detla.

Definition at line 102 of file dropout.hpp.

◆ Delta() [2/2]

OutputDataType& Delta ( )
inline

Modify the delta.

Definition at line 104 of file dropout.hpp.

◆ Deterministic() [1/2]

bool Deterministic ( ) const
inline

The value of the deterministic parameter.

Definition at line 107 of file dropout.hpp.

◆ Deterministic() [2/2]

bool& Deterministic ( )
inline

Modify the value of the deterministic parameter.

Definition at line 109 of file dropout.hpp.

◆ Forward()

void Forward ( const arma::Mat< eT > &  input,
arma::Mat< eT > &  output 
)

Ordinary feed forward pass of the dropout layer.

Parameters
inputInput data used for evaluating the specified function.
outputResulting output activation.

◆ operator=() [1/2]

Dropout& operator= ( const Dropout< InputDataType, OutputDataType > &  layer)

Copy assignment operator.

◆ operator=() [2/2]

Dropout& operator= ( Dropout< InputDataType, OutputDataType > &&  layer)

Move assignment operator.

◆ OutputParameter() [1/2]

OutputDataType const& OutputParameter ( ) const
inline

Get the output parameter.

Definition at line 97 of file dropout.hpp.

◆ OutputParameter() [2/2]

OutputDataType& OutputParameter ( )
inline

Modify the output parameter.

Definition at line 99 of file dropout.hpp.

◆ Ratio() [1/2]

double Ratio ( ) const
inline

The probability of setting a value to zero.

Definition at line 112 of file dropout.hpp.

◆ Ratio() [2/2]

void Ratio ( const double  r)
inline

Modify the probability of setting a value to zero.

Definition at line 115 of file dropout.hpp.

References Dropout< InputDataType, OutputDataType >::serialize().

◆ serialize()

void serialize ( Archive &  ar,
const uint32_t   
)

Serialize the layer.

Referenced by Dropout< InputDataType, OutputDataType >::Ratio().


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-git/src/mlpack/methods/ann/layer/dropout.hpp