Package weka.attributeSelection
Class Ranker
java.lang.Object
weka.attributeSelection.ASSearch
weka.attributeSelection.Ranker
- All Implemented Interfaces:
Serializable,RankedOutputSearch,StartSetHandler,OptionHandler,RevisionHandler
Ranker :
Ranks attributes by their individual evaluations. Use in conjunction with attribute evaluators (ReliefF, GainRatio, Entropy etc).
Valid options are:
Ranks attributes by their individual evaluations. Use in conjunction with attribute evaluators (ReliefF, GainRatio, Entropy etc).
Valid options are:
-P <start set> Specify a starting set of attributes. Eg. 1,3,5-7. Any starting attributes specified are ignored during the ranking.
-T <threshold> Specify a theshold by which attributes may be discarded from the ranking.
-N <num to select> Specify number of attributes to select
- Version:
- $Revision: 15520 $
- Author:
- Mark Hall (mhall@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the tip text for this propertyintGets the calculated number to select.booleanThis is a dummy method.intGets the number of attributes to be retained.String[]Gets the current settings of ReliefFAttributeEval.Returns the revision string.Returns a list of attributes (and or attribute ranges) as a StringdoubleReturns the threshold so that the AttributeSelection module can discard attributes from the ranking.Returns a string describing this search methodReturns an enumeration describing the available options.Returns the tip text for this propertydouble[][]Sorts the evaluated attribute listint[]search(ASEvaluation ASEval, Instances data) Kind of a dummy search algorithm.voidsetGenerateRanking(boolean doRank) This is a dummy set method---Ranker is ONLY capable of producing a ranked list of attributes for attribute evaluators.voidsetNumToSelect(int n) Specify the number of attributes to select from the ranked list.voidsetOptions(String[] options) Parses a given list of options.voidsetStartSet(String startSet) Sets a starting set of attributes for the search.voidsetThreshold(double threshold) Set the threshold by which the AttributeSelection module can discard attributes.Returns the tip text for this propertyReturns the tip text for this propertytoString()returns a description of the search as a StringMethods inherited from class weka.attributeSelection.ASSearch
forName, makeCopies
-
Constructor Details
-
Ranker
public Ranker()Constructor
-
-
Method Details
-
globalInfo
Returns a string describing this search method- Returns:
- a description of the search suitable for displaying in the explorer/experimenter gui
-
numToSelectTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setNumToSelect
public void setNumToSelect(int n) Specify the number of attributes to select from the ranked list. -1 indicates that all attributes are to be retained.- Specified by:
setNumToSelectin interfaceRankedOutputSearch- Parameters:
n- the number of attributes to retain
-
getNumToSelect
public int getNumToSelect()Gets the number of attributes to be retained.- Specified by:
getNumToSelectin interfaceRankedOutputSearch- Returns:
- the number of attributes to retain
-
getCalculatedNumToSelect
public int getCalculatedNumToSelect()Gets the calculated number to select. This might be computed from a threshold, or if < 0 is set as the number to select then it is set to the number of attributes in the (transformed) data.- Specified by:
getCalculatedNumToSelectin interfaceRankedOutputSearch- Returns:
- the calculated number of attributes to select
-
thresholdTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setThreshold
public void setThreshold(double threshold) Set the threshold by which the AttributeSelection module can discard attributes.- Specified by:
setThresholdin interfaceRankedOutputSearch- Parameters:
threshold- the threshold.
-
getThreshold
public double getThreshold()Returns the threshold so that the AttributeSelection module can discard attributes from the ranking.- Specified by:
getThresholdin interfaceRankedOutputSearch- Returns:
- a threshold by which to discard attributes
-
generateRankingTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setGenerateRanking
public void setGenerateRanking(boolean doRank) This is a dummy set method---Ranker is ONLY capable of producing a ranked list of attributes for attribute evaluators.- Specified by:
setGenerateRankingin interfaceRankedOutputSearch- Parameters:
doRank- this parameter is N/A and is ignored
-
getGenerateRanking
public boolean getGenerateRanking()This is a dummy method. Ranker can ONLY be used with attribute evaluators and as such can only produce a ranked list of attributes- Specified by:
getGenerateRankingin interfaceRankedOutputSearch- Returns:
- true all the time.
-
startSetTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setStartSet
Sets a starting set of attributes for the search. It is the search method's responsibility to report this start set (if any) in its toString() method.- Specified by:
setStartSetin interfaceStartSetHandler- Parameters:
startSet- a string containing a list of attributes (and or ranges), eg. 1,2,6,10-15.- Throws:
Exception- if start set can't be set.
-
getStartSet
Returns a list of attributes (and or attribute ranges) as a String- Specified by:
getStartSetin interfaceStartSetHandler- Returns:
- a list of attributes (and or attribute ranges)
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classASSearch- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-P <start set> Specify a starting set of attributes. Eg. 1,3,5-7. Any starting attributes specified are ignored during the ranking.
-T <threshold> Specify a theshold by which attributes may be discarded from the ranking.
-N <num to select> Specify number of attributes to select
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classASSearch- 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 ReliefFAttributeEval.- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classASSearch- Returns:
- an array of strings suitable for passing to setOptions()
-
search
Kind of a dummy search algorithm. Calls a Attribute evaluator to evaluate each attribute not included in the startSet and then sorts them to produce a ranked list of attributes. -
rankedAttributes
Sorts the evaluated attribute list- Specified by:
rankedAttributesin interfaceRankedOutputSearch- Returns:
- an array of sorted (highest eval to lowest) attribute indexes
- Throws:
Exception- of sorting can't be done.
-
toString
returns a description of the search as a String -
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classASSearch- Returns:
- the revision
-