margin

Margin of k-nearest neighbor classifier

Syntax

m = margin(mdl,Tbl,ResponseVarName)

m = margin(mdl,Tbl,Y)

m = margin(mdl,X,Y)

Description

m = margin(mdl,Tbl,ResponseVarName) returns the classification margins for mdl with data Tbl and classification Tbl.ResponseVarName. If Tbl contains the response variable used to train mdl, then you do not need to specify ResponseVarName.

m is returned as a numeric vector of length size(Tbl,1). Each entry in m represents the margin for the corresponding row of Tbl and the corresponding true class label in Tbl.ResponseVarName, computed using mdl.

m = margin(mdl,Tbl,Y) returns the classification margins for mdl with data Tbl and classification Y.

m = margin(mdl,X,Y) returns the classification margins for mdl with data X and classification Y. m is returned as a numeric vector of length size(X,1).

Examples

Margin Calculation

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 margin of the classifier for a mean observation classified as 'versicolor'.

X = mean(meas);
Y = {'versicolor'};
m = margin(mdl,X,Y)

m = 
1

All five nearest neighbors classify as 'versicolor'.

Input Arguments

mdl — k-nearest neighbor classifier model

ClassificationKNN object

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

Tbl — Sample data

table

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 margin must also be in a table.

Data Types: table

ResponseVarName — Response variable name

name of a variable in Tbl

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

X — Predictor data

numeric matrix

Predictor data, specified as a numeric matrix. Each row of X represents one observation, and each column represents one variable.

Data Types: single | double

Y — Class labels

categorical array | character array | string array | logical vector | numeric vector | cell array of character vectors

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

More About

Margin

The classification margin for each observation is the difference between the classification score for the true class and the maximal classification score for the false classes.

Score

The score of a classification is the posterior probability of the classification. The posterior probability is the number of neighbors with that classification divided by the number of neighbors. For a more detailed definition that includes weights and prior probabilities, see Posterior Probability.

Extended Capabilities

Tall Arrays

Calculate with arrays that have more rows than fit in memory.

The margin function fully supports tall arrays. For more information, see Tall Arrays.

GPU Arrays

Accelerate code by running on a graphics processing unit (GPU) using Parallel Computing Toolbox™.

Usage notes and limitations:

• margin does not support GPU arrays for ClassificationKNN models with the following specifications:

  • The 'NSMethod' property is specified as 'kdtree'.

  • The 'Distance' property is specified as a function handle.

  • The 'IncludeTies' property is specified as true.

For more information, see Run MATLAB Functions on a GPU (Parallel Computing Toolbox).

Version History

Introduced in R2012a