biz.sc.mm.dm.supervised.statistical

Interface VariableSelectionSettings

All Superinterfaces:

Verifiable

public interface VariableSelectionSettings
extends Verifiable

Common settings for variable selection heuristics.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExclusions(java.lang.String[] names) Adds new exclusion group with exclusion level set to 1.
void	addExclusions(java.lang.String[] names, int level) Adds new exclusion group with specified exclusion level.
void	clearAllExclusions() Removes all information on exclusion groups.
AuxiliaryLiftEstimationMode	getAuxiliaryLiftEstimationMode() Gets the auxiliary lift estimation mode.
AuxiliaryStatisticsMode	getAuxiliaryStatisticsMode() Gets auxiliary statistics switch value.
java.util.HashMap	getExclusionMap(java.lang.String name) Gets the map of exclusion groups for a given variable.
boolean	getGroupMode() Gets the status of grouped variable selection mode.
int	getMaxModelSize() Gets the maximal model size (the number of variables in model).
double	getModelEntryLevel() Gets the entry level (p-value) for variable insertion test.
double	getModelLeaveLevel() Gets the leave level (p-value) for variable removal test.
VariableSelectionMethod	getVariableSelectionMethod() Gets the current variable selection method.
VariableSignificanceMode	getVariableSignificanceMode() Gets current variable significance test mode (e.g.
boolean	isPearsonBasedSweepMode()
boolean	isReversibleSweepMode()
boolean	isSubsweepMode()
boolean	isTriangularSweepMode()
void	setAuxiliaryLiftEstimationMode(AuxiliaryLiftEstimationMode auxLiftMode) Sets the auxiliary lift estimation mode.
void	setAuxiliaryStatisticsMode(AuxiliaryStatisticsMode auxStatsMode) Sets auxiliary statistics switch value.
void	setGroupMode(boolean mode) Sets the status of grouped variable selection mode.
void	setMaxModelSize(int modelSize) Sets the maximal model size (the number of variables in model).
void	setModelEntryLevel(double level) Sets the entry level (p-value) for variable insertion test.
void	setModelLeaveLevel(double level) Sets the leave level (p-value) for variable removal test.
void	setPearsonBasedSweepMode(boolean pearsonBasedSweepMode)
void	setReversibleSweepMode(boolean reversibleSweepMode)
void	setSubsweepMode(boolean subsweepMode)
void	setTriangularSweepMode(boolean triangularMode)
void	setVariableSelectionMethod(VariableSelectionMethod method) Sets the current variable selection method.
void	setVariableSignificanceMode(VariableSignificanceMode significanceMode) Sets other than standard (LikelihoodRatio,Type2SS) variable significance tests, e.g. based on scoring criteria (ROC/AUC, K-S).

Methods inherited from interface biz.sc.mm.dm.base.Verifiable

verify

Method Detail

getVariableSelectionMethod

VariableSelectionMethod getVariableSelectionMethod()

Gets the current variable selection method.

Returns:

variable selection method.

setVariableSelectionMethod

void setVariableSelectionMethod(VariableSelectionMethod method)

Sets the current variable selection method.

Parameters:

method - variable selection method.

getModelEntryLevel

double getModelEntryLevel()

Gets the entry level (p-value) for variable insertion test.

Returns:

v the entry level value (p-value).

setModelEntryLevel

void setModelEntryLevel(double level)

Sets the entry level (p-value) for variable insertion test.

Parameters:

level - the entry level value (p-value).

getModelLeaveLevel

double getModelLeaveLevel()

Gets the leave level (p-value) for variable removal test.

Returns:

the leave level value (p-value).

setModelLeaveLevel

void setModelLeaveLevel(double level)

Sets the leave level (p-value) for variable removal test.

Parameters:

level - the leave level value (p-value).

getMaxModelSize

int getMaxModelSize()

Gets the maximal model size (the number of variables in model).

Returns:

the maximal model size.

setMaxModelSize

void setMaxModelSize(int modelSize)

Sets the maximal model size (the number of variables in model).

Parameters:

modelSize - the maximal model size.

getGroupMode

boolean getGroupMode()

Gets the status of grouped variable selection mode.

Returns:

the status of grouped variable selection mode.

setGroupMode

void setGroupMode(boolean mode)

Sets the status of grouped variable selection mode.

Parameters:

mode - the status of grouped variable selection mode.

getAuxiliaryStatisticsMode

AuxiliaryStatisticsMode getAuxiliaryStatisticsMode()

Gets auxiliary statistics switch value.

Returns:

auxiliary variable selection statistics computation mode.

setAuxiliaryStatisticsMode

void setAuxiliaryStatisticsMode(AuxiliaryStatisticsMode auxStatsMode)

Sets auxiliary statistics switch value.

Parameters:

auxStatsMode - auxiliary variable selection statistics computation mode.

getAuxiliaryLiftEstimationMode

AuxiliaryLiftEstimationMode getAuxiliaryLiftEstimationMode()

Gets the auxiliary lift estimation mode.

Returns:

the value of AuxiliaryLiftEstimationMode enumeration.

See Also:

enumeration comments.

setAuxiliaryLiftEstimationMode

void setAuxiliaryLiftEstimationMode(AuxiliaryLiftEstimationMode auxLiftMode)

Sets the auxiliary lift estimation mode.

Parameters:

auxLiftMode - the value of AuxiliaryLiftEstimationMode enumeration.

See Also:

enumeration comments.

getVariableSignificanceMode

VariableSignificanceMode getVariableSignificanceMode()

Gets current variable significance test mode (e.g. LikelihoodRatio/Type2SS, ROC/AUC, K-S).

Returns:

the value of VariableSignificanceMode enumeration.

See Also:

enumeration comments.

setVariableSignificanceMode

void setVariableSignificanceMode(VariableSignificanceMode significanceMode)

Sets other than standard (LikelihoodRatio,Type2SS) variable significance tests, e.g. based on scoring criteria (ROC/AUC, K-S).

Parameters:

significanceMode - the value of VariableSignificanceMode enumeration.

See Also:

enumeration comments.

isTriangularSweepMode

boolean isTriangularSweepMode()

setTriangularSweepMode

void setTriangularSweepMode(boolean triangularMode)

isReversibleSweepMode

boolean isReversibleSweepMode()

setReversibleSweepMode

void setReversibleSweepMode(boolean reversibleSweepMode)

isPearsonBasedSweepMode

boolean isPearsonBasedSweepMode()

setPearsonBasedSweepMode

void setPearsonBasedSweepMode(boolean pearsonBasedSweepMode)

isSubsweepMode

boolean isSubsweepMode()

setSubsweepMode

void setSubsweepMode(boolean subsweepMode)

clearAllExclusions

void clearAllExclusions()

Removes all information on exclusion groups.

addExclusions

void addExclusions(java.lang.String[] names)

Adds new exclusion group with exclusion level set to 1.

Parameters:

names - group names or attribute names (depending on groupMode flag).

addExclusions

void addExclusions(java.lang.String[] names,
                 int level)

Adds new exclusion group with specified exclusion level.

Parameters:

names - group names or attribute names (depending on groupMode flag).

exclusionLevel - maximal number of attr/groups present in the model at the same time.

getExclusionMap

java.util.HashMap getExclusionMap(java.lang.String name)

Gets the map of exclusion groups for a given variable.

Parameters:

name - variable name.

Returns:

the map of exclusion groups.