Skip to Main Content Skip to Search
Product Documentation

margin - Class: CompactClassificationEnsemble

Classification margins

Syntax

M = margin(ens,X,Y)
M = margin(ens,X,Y,Name,Value)

Description

M = margin(ens,X,Y) returns the classification margin for the predictions of ens on data X, when the true classifications are Y.

M = margin(ens,X,Y,Name,Value) calculates margin with additional options specified by one or more Name,Value pair arguments.

Input Arguments

ens

Classification ensemble created with fitensemble, or a compact classification ensemble created with compact.

X

Matrix of data to classify. Each row of X represents one observation, and each column represents one predictor. X must have the same number of columns as the data used to train ens. X should have the same number of rows as the number of elements in Y.

Y

Classification of X. Y should be of the same type as the classification used to train ens, and its number of elements should equal the number of rows of X.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments, where Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

'learners'

Indices of weak learners in the ensemble ranging from 1 to ens.NTrained. oobEdge uses only these learners for calculating loss.

Default: 1:NTrained

'UseObsForLearner'

A logical matrix of size N-by-T, where:

  • N is the number of rows of X.

  • T is the number of weak learners in ens.

When UseObsForLearner(i,j) is true, learner j is used in predicting the class of row i of X.

Default: true(N,T)

Output Arguments

M

A numeric column vector with the same number of rows as X. Each row of M gives the classification margin for that row of X.

Definitions

Margin

The classification margin is the difference between the classification score for the true class and maximal classification score for the false classes. Margin is a column vector with the same number of rows as in the matrix X.

Score (ensemble)

For ensembles, a classification score represents the confidence of a classification into a class. The higher the score, the higher the confidence.

Different ensemble algorithms have different definitions for their scores. Furthermore, the range of scores depends on ensemble type. For example:

Examples

Find the margin for classifying an average flower from the Fisheriris data as 'versicolor':

load fisheriris % X = meas, Y = species
ens = fitensemble(meas,species,'AdaBoostM2',100,'Tree');
flower = mean(meas);
predict(ens,flower)

ans = 
    'versicolor'

margin(ens,mean(meas),'versicolor')

ans =
    3.2140

See Also

edge | loss | predict

How To

  

 

 © 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS