SigmoidCrossEntropyError< InputDataType, OutputDataType > Class Template Reference

The SigmoidCrossEntropyError performance function measures the network's performance according to the cross-entropy function between the input and target distributions. More...

Public Member Functions
	SigmoidCrossEntropyError ()
	Create the SigmoidCrossEntropyError object. More...
template < typename eT >
void	Backward (const arma::Mat< eT > &&input, const arma::Mat< eT > &&target, arma::Mat< eT > &&output)
	Ordinary feed backward pass of a neural network. More...
OutputDataType &	Delta () const
	Get the delta. More...
OutputDataType &	Delta ()
	Modify the delta. More...
template < typename eT >
double	Forward (const arma::Mat< eT > &&input, const arma::Mat< eT > &&target)
InputDataType &	InputParameter () const
	Get the input parameter. More...
InputDataType &	InputParameter ()
	Modify the input parameter. More...
OutputDataType &	OutputParameter () const
	Get the output parameter. More...
OutputDataType &	OutputParameter ()
	Modify the output parameter. More...
template < typename Archive >
void	serialize (Archive &ar, const unsigned int)
	Serialize the layer. More...

Detailed Description

template

<

typename

InputDataType

=

arma::mat

,

typename

OutputDataType

=

arma::mat

>

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

The SigmoidCrossEntropyError performance function measures the network's performance according to the cross-entropy function between the input and target distributions.

This function calculates the cross entropy given the real values instead of providing the sigmoid activations. The function uses this equivalent formulation: where x = input and z = target.

For more information, see the following paper.

@article{1702.05659,
  title={On Loss Functions for Deep Neural Networks in Classification},
  author={Katarzyna Janocha, Wojciech Marian Czarnecki},
  url = {http://arxiv.org/abs/1702.05659},
  journal = {CoRR},
  eprint={arXiv:1702.05659},
  year={2017}
}

Template Parameters

InputDataType	Type of the input data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).
OutputDataType	Type of the output data (arma::colvec, arma::mat, arma::sp_mat or arma::cube).

Definition at line 51 of file sigmoid_cross_entropy_error.hpp.

Constructor & Destructor Documentation

SigmoidCrossEntropyError()

SigmoidCrossEntropyError

(

)

Create the SigmoidCrossEntropyError object.

Member Function Documentation

Backward()

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

inline

Ordinary feed backward pass of a neural network.

Parameters

input	The propagated input activation.
target	The target vector.
output	The calculated error.

Delta() [1/2]

OutputDataType& Delta ( ) const

inline

Get the delta.

Definition at line 91 of file sigmoid_cross_entropy_error.hpp.

Delta() [2/2]

OutputDataType& Delta ( )

inline

Modify the delta.

Definition at line 93 of file sigmoid_cross_entropy_error.hpp.

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

Forward()

double Forward ( const arma::Mat< eT > &&  input, const arma::Mat< eT > &&  target  )

inline

InputParameter() [1/2]

InputDataType& InputParameter ( ) const

inline

Get the input parameter.

Definition at line 81 of file sigmoid_cross_entropy_error.hpp.

InputParameter() [2/2]

InputDataType& InputParameter ( )

inline

Modify the input parameter.

Definition at line 83 of file sigmoid_cross_entropy_error.hpp.

OutputParameter() [1/2]

OutputDataType& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 86 of file sigmoid_cross_entropy_error.hpp.

OutputParameter() [2/2]

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 88 of file sigmoid_cross_entropy_error.hpp.

serialize()

void serialize	(	Archive &	ar,
		const unsigned	int
	)

Serialize the layer.

Referenced by SigmoidCrossEntropyError< InputDataType, OutputDataType >::Delta().

---

The documentation for this class was generated from the following file:

• src/mlpack/methods/ann/layer/sigmoid_cross_entropy_error.hpp