Main Content

loss

R2026b

Classification loss for discriminant analysis classifier

Description

L = loss(Mdl,Tbl,ResponseVarName) returns the classification loss, a scalar representing how well the trained discriminant analysis classifier Mdl classifies the predictor data in table Tbl compared to the true class labels in Tbl.ResponseVarName.

The classification loss (L) is a generalization or resubstitution quality measure. Its interpretation depends on the loss function and weighting scheme, but, in general, better classifiers yield smaller classification loss values.

L = loss(Mdl,Tbl,Y) returns the classification loss for the classifier Mdl using the predictor data in table Tbl and the class labels in Y.

L = loss(Mdl,X,Y) returns the classification loss for the trained discriminant analysis classifier Mdl using the predictor data X and the corresponding class labels in Y.

example

L = loss(___,Name=Value) specifies additional options using one or more name-value arguments in addition to any of the input argument combinations in the previous syntaxes. For example, you can specify a classification loss function and the observation weights.

Examples

collapse all

Load Fisher's iris data set.

load fisheriris

Train a discriminant analysis model using all observations in the data.

Mdl = fitcdiscr(meas,species);

Estimate the classification error of the model using the training observations.

L = loss(Mdl,meas,species)
L = 
0.0200

Alternatively, if Mdl is not compact, then you can estimate the training-sample classification error by passing Mdl to resubLoss.

Input Arguments

collapse all

Trained discriminant analysis classifier, specified as a ClassificationDiscriminant model object trained with fitcdiscr, or a CompactClassificationDiscriminant model object created with compact.

Sample data used to train the model, specified as a table. Each row of Tbl corresponds to one observation, and each column corresponds to one predictor variable. Categorical predictor variables are not supported. Optionally, Tbl can contain additional columns for the response variable (which can be categorical) and observation weights. Tbl must contain all of the predictor variables used to train Mdl. Multicolumn variables and cell arrays other than cell arrays of character vectors are not allowed.

If Tbl contains the response variable used to train Mdl, then you do not need to specify ResponseVarName or Y.

If you trained Mdl using sample data contained in a table, then the input data for loss must also be in a table.

Data Types: table

Response variable name, specified as the name of a variable in Tbl. If Tbl contains the response variable used to train Mdl, then you do not need to specify ResponseVarName.

You must specify ResponseVarName as a character vector or string scalar. For example, if the response variable Y is stored as Tbl.Y, then specify it as "Y". Otherwise, the software treats all columns of Tbl, including Y, as predictors.

The response variable must be a categorical, character, or string array, a logical or numeric vector, or a cell array of character vectors. If the response variable is a character array, then each element must correspond to one row of the array.

Data Types: char | string

Predictor data, specified as a numeric matrix. Each row of X corresponds to one observation, and each column corresponds to one predictor variable. Categorical predictor variables are not supported. The variables in the columns of X must be the same as the variables used to train Mdl. The number of rows in X must equal the number of rows in Y.

If you trained Mdl using sample data contained in a matrix, then the input data for loss must also be in a matrix.

Data Types: single | double

Class labels, specified as a categorical, character, or string array, a logical or numeric vector, or a cell array of character vectors. Y must have the same data type as the response data used to train Mdl. (The software treats string arrays as cell arrays of character vectors.)

The length of Y must equal the number of rows in Tbl or X.

Data Types: categorical | char | string | logical | single | double | cell

Name-Value Arguments

collapse all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: loss(Mdl,meas,species,LossFun="binodeviance") specifies binomial deviance as the loss function.

Loss function, specified as a built-in loss function name or a function handle.

The following table describes the values for the built-in loss functions. Specify one using the corresponding character vector or string scalar.

ValueDescription
"binodeviance"Binomial deviance
"classifcost"Observed misclassification cost
"classiferror"Misclassified rate in decimal
"exponential"Exponential loss
"hinge"Hinge loss
"logit"Logistic loss
"mincost"Minimal expected misclassification cost (for classification scores that are posterior probabilities)
"quadratic"Quadratic loss

"mincost" is appropriate for classification scores that are posterior probabilities. Discriminant analysis classifiers return posterior probabilities as classification scores by default (see predict).

Specify your own function using function handle notation. Suppose that n is the number of observations in X, and K is the number of distinct classes (numel(Mdl.ClassNames)). Your function must have the signature

lossvalue = lossfun(C,S,W,Cost)
where:

  • The output argument lossvalue is a scalar.

  • You specify the function name (lossfun).

  • C is an n-by-K logical matrix with rows indicating the class to which the corresponding observation belongs. The column order corresponds to the class order in Mdl.ClassNames.

    Create C by setting C(p,q) = 1, if observation p is in class q, for each row. Set all other elements of row p to 0.

  • S is an n-by-K numeric matrix of classification scores. The column order corresponds to the class order in Mdl.ClassNames. S is a matrix of classification scores, similar to the output of predict.

  • W is an n-by-1 numeric vector of observation weights. If you pass W, the software normalizes the weights to sum to 1.

  • Cost is a K-by-K numeric matrix of misclassification costs. For example, Cost = ones(K) - eye(K) specifies a cost of 0 for correct classification and 1 for misclassification.

Example: LossFun="binodeviance"

Example: LossFun=@Lossfun

Data Types: char | string | function_handle

Since R2026b

Class weights, or prior probabilities, specified as "empirical", "uniform", or a numeric vector.

ValueDescription
"empirical" loss uses the class frequencies in Y or Tbl.ResponseVarName. The function returns an unweighted loss, with respect to class.
"uniform" loss assigns a weight of 1/K to each class, where K is the number of classes.
Numeric vectorSpecify a custom weight for each class. The sum of the weights must equal 1.

By default, loss uses the class prior probabilities specified in the Prior property of the classification model.

Example: Prior="empirical"

Data Types: single | double | char | string

Observation weights, specified as a numeric vector or the name of a variable in Tbl. The software weights the observations in each row of X or Tbl with the corresponding weight in Weights.

If you specify Weights as a numeric vector, then the size of Weights must be equal to the number of rows in X or Tbl.

If you specify Weights as the name of a variable in Tbl, you must do so as a character vector or string scalar. For example, if the weights are stored as Tbl.W, then specify Weights as "W". Otherwise, the software treats all columns of Tbl, including Tbl.W, as predictors.

If you do not specify your own loss function, then the software normalizes Weights to sum up to the value of the prior probability in the respective class.

Example: Weights="W"

Data Types: single | double | char | string

Output Arguments

collapse all

Classification loss, returned as a numeric scalar. The interpretation of L depends on LossFun, Prior, and Weights. For more information, see Classification Loss.

More About

collapse all

Tips

  • By default, loss uses the class probabilities specified during training (which are stored in the Prior property of the classification model) to compute the classification loss. To return the class-unweighted loss, specify Prior="empirical". (since R2026b)

  • If the predictor data in X or Tbl contains any missing values and LossFun is not set to "classifcost", "classiferror", or "mincost", the loss function might return NaN. (since R2022a)

    If loss in your code returns NaN, you can update your code to avoid this result by doing one of the following:

    • Remove or replace the missing values by using rmmissing or fillmissing, respectively.

    • Specify the name-value argument LossFun as "classifcost", "classiferror", or "mincost".

Extended Capabilities

expand all

Version History

Introduced in R2011b

expand all