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

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

#include <hinge_embedding_loss.hpp>

Public Member Functions
	HingeEmbeddingLoss ()
	Create the Hinge Embedding object.
template<typename PredictionType , typename TargetType >
PredictionType::elem_type	Forward (const PredictionType &prediction, const TargetType &target)
	Computes the Hinge Embedding loss function. 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...
OutputDataType &	OutputParameter () const
	Get the output parameter.
OutputDataType &	OutputParameter ()
	Modify the output parameter.
template<typename Archive >
void	serialize (Archive &ar, const uint32_t)
	Serialize the loss function.

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).

Member Function Documentation

Backward()

template<typename InputDataType , typename OutputDataType >

template<typename PredictionType , typename TargetType , typename LossType >

void mlpack::ann::HingeEmbeddingLoss< InputDataType, OutputDataType >::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()

template<typename InputDataType , typename OutputDataType >

template<typename PredictionType , typename TargetType >

PredictionType::elem_type mlpack::ann::HingeEmbeddingLoss< InputDataType, OutputDataType >::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.

---

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

• src/mlpack/methods/ann/loss_functions/hinge_embedding_loss.hpp
• src/mlpack/methods/ann/loss_functions/hinge_embedding_loss_impl.hpp