Package weka.attributeSelection
Class CostSensitiveASEvaluation
java.lang.Object
weka.attributeSelection.ASEvaluation
weka.attributeSelection.CostSensitiveASEvaluation
- All Implemented Interfaces:
Serializable
,CapabilitiesHandler
,OptionHandler
,RevisionHandler
- Direct Known Subclasses:
CostSensitiveAttributeEval
,CostSensitiveSubsetEval
public abstract class CostSensitiveASEvaluation
extends ASEvaluation
implements OptionHandler, Serializable
Abstract base class for cost-sensitive subset and attribute evaluators.
- Version:
- $Revision: 5562 $
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
load cost matrix on demandstatic final int
use explicit cost matrixstatic final Tag[]
Specify possible sources of the cost matrix -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildEvaluator
(Instances data) Generates a attribute evaluator.Return the name of the default evaluator.Returns the tip text for this propertyReturns default capabilities of the classifier.Gets the misclassification cost matrix.Gets the source location method of the cost matrix.Get the evaluator used as the base evaluator.Returns the directory that will be searched for cost files when loading on demand.String[]
Gets the current settings of the subset evaluator.Returns the revision string.int
getSeed()
Gets the seed for the random number generations.Returns an enumeration describing the available options.int[]
postProcess
(int[] attributeSet) Provides a chance for a attribute evaluator to do any special post processing of the selected attribute set.Returns the tip text for this propertyvoid
setCostMatrix
(CostMatrix newCostMatrix) Sets the misclassification cost matrix.void
setCostMatrixSource
(SelectedTag newMethod) Sets the source location of the cost matrix.void
setEvaluator
(ASEvaluation newEvaluator) Set the base evaluator.void
setOnDemandDirectory
(File newDir) Sets the directory that will be searched for cost files when loading on demand.void
setOptions
(String[] options) Parses a given list of options.void
setSeed
(int seed) Set the seed for random number generation.toString()
Output a representation of this evaluatorMethods inherited from class weka.attributeSelection.ASEvaluation
clean, forName, makeCopies
-
Field Details
-
MATRIX_ON_DEMAND
public static final int MATRIX_ON_DEMANDload cost matrix on demand- See Also:
-
MATRIX_SUPPLIED
public static final int MATRIX_SUPPLIEDuse explicit cost matrix- See Also:
-
TAGS_MATRIX_SOURCE
Specify possible sources of the cost matrix
-
-
Constructor Details
-
CostSensitiveASEvaluation
public CostSensitiveASEvaluation()
-
-
Method Details
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptions
in interfaceOptionHandler
- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-C <cost file name> File name of a cost matrix to use. If this is not supplied, a cost matrix will be loaded on demand. The name of the on-demand file is the relation name of the training data plus ".cost", and the path to the on-demand file is specified with the -N option.
-N <directory> Name of a directory to search for cost files when loading costs on demand (default current directory).
-cost-matrix <matrix> The cost matrix in Matlab single line format.
-S <integer> The seed to use for random number generation.
-W Full name of base evaluator. (default: weka.attributeSelection.CfsSubsetEval)
Options after -- are passed to the designated evaluator.- Specified by:
setOptions
in interfaceOptionHandler
- Parameters:
options
- the list of options as an array of strings- Throws:
Exception
- if an option is not supported
-
getOptions
Gets the current settings of the subset evaluator.- Specified by:
getOptions
in interfaceOptionHandler
- Returns:
- an array of strings suitable for passing to setOptions
-
globalInfo
- Returns:
- a description of the classifier suitable for displaying in the explorer/experimenter gui
-
defaultEvaluatorString
Return the name of the default evaluator.- Returns:
- the name of the default evaluator
-
costMatrixSourceTipText
- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getCostMatrixSource
Gets the source location method of the cost matrix. Will be one of MATRIX_ON_DEMAND or MATRIX_SUPPLIED.- Returns:
- the cost matrix source.
-
setCostMatrixSource
Sets the source location of the cost matrix. Values other than MATRIX_ON_DEMAND or MATRIX_SUPPLIED will be ignored.- Parameters:
newMethod
- the cost matrix location method.
-
onDemandDirectoryTipText
- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getOnDemandDirectory
Returns the directory that will be searched for cost files when loading on demand.- Returns:
- The cost file search directory.
-
setOnDemandDirectory
Sets the directory that will be searched for cost files when loading on demand.- Parameters:
newDir
- The cost file search directory.
-
costMatrixTipText
- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getCostMatrix
Gets the misclassification cost matrix.- Returns:
- the cost matrix
-
setCostMatrix
Sets the misclassification cost matrix.- Parameters:
newCostMatrix
- the cost matrix
-
seedTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setSeed
public void setSeed(int seed) Set the seed for random number generation.- Parameters:
seed
- the seed
-
getSeed
public int getSeed()Gets the seed for the random number generations.- Returns:
- the seed for the random number generation
-
evaluatorTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setEvaluator
Set the base evaluator.- Parameters:
newEvaluator
- the evaluator to use.- Throws:
IllegalArgumentException
- if the evaluator is of the wrong type
-
getEvaluator
Get the evaluator used as the base evaluator.- Returns:
- the evaluator used as the base evaluator
-
getCapabilities
Returns default capabilities of the classifier.- Specified by:
getCapabilities
in interfaceCapabilitiesHandler
- Overrides:
getCapabilities
in classASEvaluation
- Returns:
- the capabilities of this classifier
- See Also:
-
buildEvaluator
Generates a attribute evaluator. Has to initialize all fields of the evaluator that are not being set via options.- Specified by:
buildEvaluator
in classASEvaluation
- Parameters:
data
- set of instances serving as training data- Throws:
Exception
- if the evaluator has not been generated successfully
-
postProcess
Provides a chance for a attribute evaluator to do any special post processing of the selected attribute set.- Overrides:
postProcess
in classASEvaluation
- Parameters:
attributeSet
- the set of attributes found by the search- Returns:
- a possibly ranked list of postprocessed attributes
- Throws:
Exception
- if postprocessing fails for some reason
-
toString
Output a representation of this evaluator -
getRevision
Returns the revision string.- Specified by:
getRevision
in interfaceRevisionHandler
- Overrides:
getRevision
in classASEvaluation
- Returns:
- the revision
-