KLDivergence< InputDataType, OutputDataType > Class Template Reference

The Kullback–Leibler divergence is often used for continuous distributions (direct regression). More...

Public Member Functions
	KLDivergence (const bool takeMean=false)
	Create the Kullback–Leibler Divergence object with the specified parameters. More...
template < typename InputType , typename TargetType , typename OutputType >
void	Backward (const InputType &&input, const TargetType &&target, OutputType &&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 InputType , typename TargetType >
double	Forward (const InputType &&input, const TargetType &&target)
	Computes the Kullback–Leibler divergence error function. More...
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 loss function. More...
bool	TakeMean () const
	Get the value of takeMean. More...
bool &	TakeMean ()
	Modify the value of takeMean. More...

Detailed Description

template

<

typename

InputDataType

=

arma::mat

,

typename

OutputDataType

=

arma::mat

>

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

The Kullback–Leibler divergence is often used for continuous distributions (direct regression).

For more information, see the following paper.

article{Kullback1951,
  title   = {On Information and Sufficiency},
  author  = {S. Kullback, R.A. Leibler},
  journal = {The Annals of Mathematical Statistics},
  year    = {1951}
}

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 45 of file kl_divergence.hpp.

Constructor & Destructor Documentation

KLDivergence()

KLDivergence

(

const bool

takeMean = false

)

Create the Kullback–Leibler Divergence object with the specified parameters.

Parameters

takeMean

Boolean variable to specify whether to take mean or not.

Member Function Documentation

Backward()

void Backward	(	const InputType &&	input,
		const TargetType &&	target,
		OutputType &&	output
	)

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 88 of file kl_divergence.hpp.

Delta() [2/2]

OutputDataType& Delta ( )

inline

Modify the delta.

Definition at line 90 of file kl_divergence.hpp.

Forward()

double Forward	(	const InputType &&	input,
		const TargetType &&	target
	)

Computes the Kullback–Leibler divergence error function.

Parameters

input	Input data used for evaluating the specified function.
target	Target data to compare with.

InputParameter() [1/2]

InputDataType& InputParameter ( ) const

inline

Get the input parameter.

Definition at line 78 of file kl_divergence.hpp.

InputParameter() [2/2]

InputDataType& InputParameter ( )

inline

Modify the input parameter.

Definition at line 80 of file kl_divergence.hpp.

OutputParameter() [1/2]

OutputDataType& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 83 of file kl_divergence.hpp.

OutputParameter() [2/2]

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 85 of file kl_divergence.hpp.

serialize()

void serialize	(	Archive &	ar,
		const unsigned	int
	)

Serialize the loss function.

Referenced by KLDivergence< InputDataType, OutputDataType >::TakeMean().

TakeMean() [1/2]

bool TakeMean ( ) const

inline

Get the value of takeMean.

Definition at line 93 of file kl_divergence.hpp.

TakeMean() [2/2]

bool& TakeMean ( )

inline

Modify the value of takeMean.

Definition at line 95 of file kl_divergence.hpp.

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

---

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

• src/mlpack/methods/ann/loss_functions/kl_divergence.hpp