mlpack: mlpack::ann::MeanSquaredError< InputDataType, OutputDataType > Class Template Reference

mlpack master

The mean squared error performance function measures the network's performance according to the mean of squared errors. More...

Public Member Functions
	MeanSquaredError ()
	Create the MeanSquaredError 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...

Private Attributes
OutputDataType	delta
	Locally-stored delta object. More...

InputDataType	inputParameter
	Locally-stored input parameter object. More...

OutputDataType	outputParameter
	Locally-stored output parameter object. More...

Detailed Description

template<typename InputDataType = arma::mat, typename OutputDataType = arma::mat>
class mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >

The mean squared error performance function measures the network's performance according to the mean of squared errors.

Template Parameters

ActivationFunction	Activation function used for the embedding layer.
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 34 of file mean_squared_error.hpp.

Constructor & Destructor Documentation

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

mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::MeanSquaredError ( )

Create the MeanSquaredError object.

Member Function Documentation

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

template<typename eT >

void mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::Backward	(	const arma::Mat< eT > &&	input,
		const arma::Mat< eT > &&	target,
		arma::Mat< eT > &&	output
	)

Ordinary feed backward pass of a neural network.

Parameters

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

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

OutputDataType& mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::Delta ( ) const

inline

Get the delta.

Definition at line 73 of file mean_squared_error.hpp.

References mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::delta.

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

OutputDataType& mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::Delta ( )

inline

Modify the delta.

Definition at line 75 of file mean_squared_error.hpp.

References mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::delta, and mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::Serialize().

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

template<typename eT >

double mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::Forward	(	const arma::Mat< eT > &&	input,
		const arma::Mat< eT > &&	target
	)

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

InputDataType& mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::InputParameter ( ) const

inline

Get the input parameter.

Definition at line 63 of file mean_squared_error.hpp.

References mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::inputParameter.

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

InputDataType& mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::InputParameter ( )

inline

Modify the input parameter.

Definition at line 65 of file mean_squared_error.hpp.

References mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::inputParameter.

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

OutputDataType& mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 68 of file mean_squared_error.hpp.

References mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::outputParameter.

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

OutputDataType& mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::OutputParameter ( )

inline

Modify the output parameter.

Definition at line 70 of file mean_squared_error.hpp.

References mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::outputParameter.

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

template<typename Archive >

void mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::Serialize	(	Archive &	ar,
		const unsigned	int
	)

Serialize the layer.

Referenced by mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::Delta().

Member Data Documentation

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

OutputDataType mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::delta

private

Locally-stored delta object.

Definition at line 85 of file mean_squared_error.hpp.

Referenced by mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::Delta().

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

InputDataType mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::inputParameter

private

Locally-stored input parameter object.

Definition at line 88 of file mean_squared_error.hpp.

Referenced by mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::InputParameter().

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

OutputDataType mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::outputParameter

private

Locally-stored output parameter object.

Definition at line 91 of file mean_squared_error.hpp.

Referenced by mlpack::ann::MeanSquaredError< InputDataType, OutputDataType >::OutputParameter().

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

src/mlpack/methods/ann/layer/mean_squared_error.hpp