magpie.attributes.selectors

Class WekaAttributeSelector

java.lang.Object

magpie.attributes.selectors.BaseAttributeSelector

magpie.attributes.selectors.WekaAttributeSelector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Commandable, Options, Printable

public class WekaAttributeSelector
extends BaseAttributeSelector

Encapsulates Weka's ASSearch routines for attribute selection.

Usage: [-eval <eval method> [<eval options...>]] [-search <search method> [<search options...>]]
eval method: How to evaluate attributes. Name of a Weka ASEvalution class
eval options...: Any options for the attribute evaluator.
search method: How to search for optimal set. Name of a Weka ASSearch class
eval options...: Any options for the searcher

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected weka.attributeSelection.ASEvaluation	Evaluator Weka class that is used to rank subsets of attributes
protected weka.attributeSelection.ASSearch	Searcher Weka class used to populate a list of attributes

Fields inherited from class magpie.attributes.selectors.BaseAttributeSelector

trained

Constructor Summary

Constructors

Constructor and Description
WekaAttributeSelector() Generates a WekaAttributeSelector with default methods

Method Summary

Modifier and Type	Method and Description
WekaAttributeSelector	clone()
protected static weka.attributeSelection.ASEvaluation	getASEvaluator(java.lang.String Name, java.lang.String[] Options) Generates a Weka ASEvaluator object, given name and options
protected static weka.attributeSelection.ASSearch	getASSearch(java.lang.String Name, java.lang.String[] Options) Generates a Weka ASSearch object, given names and options
java.lang.String	printDescription(boolean htmlFormat) Print full name of object, and a simple description of the options.
java.lang.String	printUsage() Print out required format for options.
void	setEvaluator(java.lang.String Name, java.lang.String[] Options) Set the method used to evaluate subsets of entries.
void	setOptions(java.util.List<java.lang.Object> OptionsObj) Set any options for this object.
void	setSearcher(java.lang.String Name, java.lang.String[] Options) Set the method used to search for optimal subsets.
protected java.util.List<java.lang.Integer>	train_protected(Dataset data) Operation that actually does the work for training.

Methods inherited from class magpie.attributes.selectors.BaseAttributeSelector

about, applyAttributeSelection, getSelectionNames, getSelections, isTrained, printCommand, printSelections, run, runCommand, train

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Searcher

protected weka.attributeSelection.ASSearch Searcher

Weka class used to populate a list of attributes

Evaluator

protected weka.attributeSelection.ASEvaluation Evaluator

Weka class that is used to rank subsets of attributes

Constructor Detail

WekaAttributeSelector

public WekaAttributeSelector()

Generates a WekaAttributeSelector with default methods

Method Detail

clone

public WekaAttributeSelector clone()

Overrides:

clone in class BaseAttributeSelector

setOptions

public void setOptions(java.util.List<java.lang.Object> OptionsObj)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

OptionsObj - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

setEvaluator

public void setEvaluator(java.lang.String Name,
                         java.lang.String[] Options)

Set the method used to evaluate subsets of entries.

Parameters:

Name - Name of ASEvaluator class

Options - Any options for that class

setSearcher

public void setSearcher(java.lang.String Name,
                        java.lang.String[] Options)

Set the method used to search for optimal subsets.

Parameters:

Name - Name of ASSearch class

Options - Any options for that class

getASSearch

protected static weka.attributeSelection.ASSearch getASSearch(java.lang.String Name,
                                                              java.lang.String[] Options)

Generates a Weka ASSearch object, given names and options

Parameters:

Name - Name of ASSearch (fully qualified)

Options - Any options (can be null)

Returns:

Newly instantiated object

getASEvaluator

protected static weka.attributeSelection.ASEvaluation getASEvaluator(java.lang.String Name,
                                                                     java.lang.String[] Options)

Generates a Weka ASEvaluator object, given name and options

Parameters:

Name - Name of ASEvaluator (fully qualified)

Options - Any options (can be null)

Returns:

Newly instantiated object

train_protected

protected java.util.List<java.lang.Integer> train_protected(Dataset data)

Description copied from class: BaseAttributeSelector

Operation that actually does the work for training. Must generate a list of attribute IDs

Specified by:

train_protected in class BaseAttributeSelector

Parameters:

data - Dataset used to train selector

Returns:

List of indexes of selected attributes

printDescription

public java.lang.String printDescription(boolean htmlFormat)

Description copied from interface: Printable

Print full name of object, and a simple description of the options. This description should print enough information to reproduce how this object was created, but not necessarily enough to run it (e.g., coefficients for the model).

Example: For a model training a separate WekaRegression for intermetallics

magpie.models.regression.SplitRegression

Splitter: AllMetalsSplitter
All Metals: magpie.models.regression.WekaRegression trees.REPTree
Contains Nonmetal: magpie.regression.LASSORegreession -maxterms 2

Specified by:

printDescription in interface Printable

Overrides:

printDescription in class BaseAttributeSelector

Parameters:

htmlFormat - Whether format for output to an HTML page (e.g., <div> to create indentation) or for printing to screen.

Returns:

String describing the model

See Also:

#printModel()