Main Content

loss

Loss of k-nearest neighbor classifier

Description

L = loss(mdl,Tbl,ResponseVarName) returns a scalar representing how well mdl classifies the data in Tbl when Tbl.ResponseVarName contains the true classifications. If Tbl contains the response variable used to train mdl, then you do not need to specify ResponseVarName.

When computing the loss, the loss function normalizes the class probabilities in Tbl.ResponseVarName to the class probabilities used for training, which are stored in the Prior property of mdl.

The meaning of the classification loss (L) depends on the loss function and weighting scheme, but, in general, better classifiers yield smaller classification loss values. For more details, see Classification Loss.

L = loss(mdl,Tbl,Y) returns a scalar representing how well mdl classifies the data in Tbl when Y contains the true classifications.

When computing the loss, the loss function normalizes the class probabilities in Y to the class probabilities used for training, which are stored in the Prior property of mdl.

L = loss(mdl,X,Y) returns a scalar representing how well mdl classifies the data in X when Y contains the true classifications.

When computing the loss, the loss function normalizes the class probabilities in Y to the class probabilities used for training, which are stored in the Prior property of mdl.

example

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

Note

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 can return NaN. For more details, see loss can return NaN for predictor data with missing values.

Examples

collapse all

Create a k-nearest neighbor classifier for the Fisher iris data, where k = 5.

Load the Fisher iris data set.

load fisheriris

Create a classifier for five nearest neighbors.

mdl = fitcknn(meas,species,'NumNeighbors',5);

Examine the loss of the classifier for a mean observation classified as 'versicolor'.

X = mean(meas);
Y = {'versicolor'};
L = loss(mdl,X,Y)
L = 
0

All five nearest neighbors classify as 'versicolor'.

Input Arguments

collapse all

k-nearest neighbor classifier model, specified as a ClassificationKNN object.

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. Optionally, Tbl can contain one additional column for the response variable. 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 train 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 is stored as Tbl.response, then specify it as 'response'. Otherwise, the software treats all columns of Tbl, including Tbl.response, as predictors.

The response variable must be a categorical, character, or string array, logical or numeric vector, or 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 represents one observation, and each column represents one variable.

Data Types: single | double

Class labels, specified as a categorical, character, or string array, logical or numeric vector, or cell array of character vectors. Each row of Y represents the classification of the corresponding row of 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.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: loss(mdl,Tbl,'response','LossFun','exponential','Weights','w') returns the weighted exponential loss of mdl classifying the data in Tbl. Here, Tbl.response is the response variable, and Tbl.w is the weight variable.

Loss function, specified as the comma-separated pair consisting of 'LossFun' and a built-in loss function name or a function handle.

  • The following table lists the available loss functions.

    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. By default, k-nearest neighbor models return posterior probabilities as classification scores (see predict).

  • You can specify a function handle for a custom loss function using @ (for example, @lossfun). Let n be the number of observations in X and K be the number of distinct classes (numel(mdl.ClassNames)). Your custom loss function must have this form:

    function lossvalue = lossfun(C,S,W,Cost)

    • 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. Construct 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. The argument 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.

    • The output argument lossvalue is a scalar.

For more details on loss functions, see Classification Loss.

Data Types: char | string | function_handle

Observation weights, specified as the comma-separated pair consisting of 'Weights' and a numeric vector or the name of a variable in Tbl.

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, the name must be 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.

loss normalizes the weights so that observation weights in each class sum to the prior probability of that class. When you supply Weights, loss computes the weighted classification loss.

Example: 'Weights','w'

Data Types: single | double | char | string

Algorithms

collapse all

Extended Capabilities

expand all

Version History

Introduced in R2012a

expand all