The Hinge Embedding loss function is often used to compute the loss between y_true and y_pred. More...

Public Member Functions
	HingeEmbeddingLoss ()
	Create the Hinge Embedding object. More...

template < typename PredictionType , typename TargetType , typename LossType >
void	Backward (const PredictionType &prediction, const TargetType &target, LossType &loss)
	Ordinary feed backward pass of a neural network. More...

template < typename PredictionType , typename TargetType >
PredictionType::elem_type	Forward (const PredictionType &prediction, const TargetType &target)
	Computes the Hinge Embedding loss function. More...

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

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

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

Detailed Description

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

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

The Hinge Embedding loss function is often used to compute the loss between y_true and y_pred.

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 36 of file hinge_embedding_loss.hpp.

Constructor & Destructor Documentation

◆ HingeEmbeddingLoss()

HingeEmbeddingLoss ( )

Create the Hinge Embedding object.

Member Function Documentation

◆ Backward()

void Backward	(	const PredictionType &	prediction,
		const TargetType &	target,
		LossType &	loss
	)

Ordinary feed backward pass of a neural network.

Parameters

prediction	Prediction used for evaluating the specified loss function.
target	The target vector.
loss	The calculated error.

◆ Forward()

PredictionType::elem_type Forward	(	const PredictionType &	prediction,
		const TargetType &	target
	)

Computes the Hinge Embedding loss function.

Parameters

prediction	Prediction used for evaluating the specified loss function.
target	Target data to compare with.

◆ OutputParameter() [1/2]

OutputDataType& OutputParameter ( ) const

inline

Get the output parameter.

Definition at line 69 of file hinge_embedding_loss.hpp.

◆ OutputParameter() [2/2]

OutputDataType& OutputParameter ( )

inline

Modify the output parameter.

Definition at line 71 of file hinge_embedding_loss.hpp.

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

◆ serialize()

void serialize	(	Archive &	ar,
		const uint32_t
	)

Serialize the loss function.

Referenced by HingeEmbeddingLoss< InputDataType, OutputDataType >::OutputParameter().

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

/home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/ann/loss_functions/hinge_embedding_loss.hpp

Public Member Functions