Loss

class Loss[source]

Bases: ABC

Abstract base class for computing Loss.

Methods

abstract evaluate(predict, target)[source]

An abstract method for evaluating the loss function. Inputs are expected in a shape of (N, *). Where N is a number of samples. Loss is computed for each sample individually.

Parameters:

  • predict (ndarray) – an array of predicted values using the model.

  • target (ndarray) – an array of the true values.

Returns:

An array with values of the loss function of the shape (N, 1).

Raises:

QiskitMachineLearningError – shapes of predict and target do not match

Return type:

ndarray

abstract gradient(predict, target)[source]

An abstract method for computing the gradient. Inputs are expected in a shape of (N, *). Where N is a number of samples. Gradient is computed for each sample individually.

Parameters:

  • predict (ndarray) – an array of predicted values using the model.

  • target (ndarray) – an array of the true values.

Returns:

An array with gradient values of the shape (N, *). The output shape depends on the loss function.

Raises:

QiskitMachineLearningError – shapes of predict and target do not match.

Return type:

ndarray