Package weka.attributeSelection
Class OneRAttributeEval
- java.lang.Object
-
- weka.attributeSelection.ASEvaluation
-
- weka.attributeSelection.OneRAttributeEval
-
- All Implemented Interfaces:
Serializable,AttributeEvaluator,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler
public class OneRAttributeEval extends ASEvaluation implements AttributeEvaluator, OptionHandler
OneRAttributeEval :
Evaluates the worth of an attribute by using the OneR classifier.
Valid options are:-S <seed> Random number seed for cross validation (default = 1)
-F <folds> Number of folds for cross validation (default = 10)
-D Use training data for evaluation rather than cross validaton
-B <minimum bucket size> Minimum number of objects in a bucket (passed on to OneR, default = 6)
- Version:
- $Revision$
- Author:
- Mark Hall (mhall@cs.waikato.ac.nz)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description OneRAttributeEval()Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbuildEvaluator(Instances data)Initializes a OneRAttribute attribute evaluator.doubleevaluateAttribute(int attribute)evaluates an individual attribute by measuring the amount of information gained about the class given the attribute.StringevalUsingTrainingDataTipText()Returns a string for this option suitable for display in the gui as a tip textStringfoldsTipText()Returns a string for this option suitable for display in the gui as a tip textCapabilitiesgetCapabilities()Returns the capabilities of this evaluator.booleangetEvalUsingTrainingData()Returns true if the training data is to be used for evaluationintgetFolds()Get the number of folds used for cross validationintgetMinimumBucketSize()Get the minimum bucket size used by oneRString[]getOptions()returns the current setup.StringgetRevision()Returns the revision string.intgetSeed()Get the random number seedStringglobalInfo()Returns a string describing this attribute evaluatorEnumeration<Option>listOptions()Returns an enumeration describing the available options.static voidmain(String[] args)Main method for testing this class.StringminimumBucketSizeTipText()Returns a string for this option suitable for display in the gui as a tip textint[]postProcess(int[] attributeSet)Provides a chance for a attribute evaluator to do any special post processing of the selected attribute set.StringseedTipText()Returns a string for this option suitable for display in the gui as a tip textvoidsetEvalUsingTrainingData(boolean e)Use the training data to evaluate attributes rather than cross validationvoidsetFolds(int folds)Set the number of folds to use for cross validationvoidsetMinimumBucketSize(int minB)Set the minumum bucket size used by OneRvoidsetOptions(String[] options)Parses a given list of options.voidsetSeed(int seed)Set the random number seed for cross validationStringtoString()Return a description of the evaluator-
Methods inherited from class weka.attributeSelection.ASEvaluation
clean, doNotCheckCapabilitiesTipText, forName, getDoNotCheckCapabilities, makeCopies, postExecution, preExecution, run, runEvaluator, setDoNotCheckCapabilities
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing this attribute evaluator- Returns:
- a description of the evaluator suitable for displaying in the explorer/experimenter gui
-
seedTipText
public String seedTipText()
Returns a string for this option suitable for display in the gui as a tip text- Returns:
- a string describing this option
-
setSeed
public void setSeed(int seed)
Set the random number seed for cross validation- Parameters:
seed- the seed to use
-
getSeed
public int getSeed()
Get the random number seed- Returns:
- an
intvalue
-
foldsTipText
public String foldsTipText()
Returns a string for this option suitable for display in the gui as a tip text- Returns:
- a string describing this option
-
setFolds
public void setFolds(int folds)
Set the number of folds to use for cross validation- Parameters:
folds- the number of folds
-
getFolds
public int getFolds()
Get the number of folds used for cross validation- Returns:
- the number of folds
-
evalUsingTrainingDataTipText
public String evalUsingTrainingDataTipText()
Returns a string for this option suitable for display in the gui as a tip text- Returns:
- a string describing this option
-
setEvalUsingTrainingData
public void setEvalUsingTrainingData(boolean e)
Use the training data to evaluate attributes rather than cross validation- Parameters:
e- true if training data is to be used for evaluation
-
minimumBucketSizeTipText
public String minimumBucketSizeTipText()
Returns a string for this option suitable for display in the gui as a tip text- Returns:
- a string describing this option
-
setMinimumBucketSize
public void setMinimumBucketSize(int minB)
Set the minumum bucket size used by OneR- Parameters:
minB- the minimum bucket size to use
-
getMinimumBucketSize
public int getMinimumBucketSize()
Get the minimum bucket size used by oneR- Returns:
- the minimum bucket size used
-
getEvalUsingTrainingData
public boolean getEvalUsingTrainingData()
Returns true if the training data is to be used for evaluation- Returns:
- true if training data is to be used for evaluation
-
listOptions
public Enumeration<Option> listOptions()
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classASEvaluation- Returns:
- an enumeration of all the available options.
-
setOptions
public void setOptions(String[] options) throws Exception
Parses a given list of options. Valid options are:-S <seed> Random number seed for cross validation (default = 1)
-F <folds> Number of folds for cross validation (default = 10)
-D Use training data for evaluation rather than cross validaton
-B <minimum bucket size> Minimum number of objects in a bucket (passed on to OneR, default = 6)
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classASEvaluation- Parameters:
options- the list of options as an array of strings- Throws:
Exception- if an option is not supported
-
getOptions
public String[] getOptions()
returns the current setup.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classASEvaluation- Returns:
- the options of the current setup
-
getCapabilities
public Capabilities getCapabilities()
Returns the capabilities of this evaluator.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classASEvaluation- Returns:
- the capabilities of this evaluator
- See Also:
Capabilities
-
buildEvaluator
public void buildEvaluator(Instances data) throws Exception
Initializes a OneRAttribute attribute evaluator. Discretizes all attributes that are numeric.- Specified by:
buildEvaluatorin classASEvaluation- Parameters:
data- set of instances serving as training data- Throws:
Exception- if the evaluator has not been generated successfully
-
evaluateAttribute
public double evaluateAttribute(int attribute) throws Exceptionevaluates an individual attribute by measuring the amount of information gained about the class given the attribute.- Specified by:
evaluateAttributein interfaceAttributeEvaluator- Parameters:
attribute- the index of the attribute to be evaluated- Returns:
- the "merit" of the attribute
- Throws:
Exception- if the attribute could not be evaluated
-
toString
public String toString()
Return a description of the evaluator
-
getRevision
public String getRevision()
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classASEvaluation- Returns:
- the revision
-
postProcess
public int[] postProcess(int[] attributeSet)
Description copied from class:ASEvaluationProvides a chance for a attribute evaluator to do any special post processing of the selected attribute set. Can also be used to clean up any data structures post attribute selection.- Overrides:
postProcessin classASEvaluation- Parameters:
attributeSet- the set of attributes found by the search- Returns:
- a possibly ranked list of postprocessed attributes
-
main
public static void main(String[] args)
Main method for testing this class.- Parameters:
args- the options
-
-