magpie.attributes.selectors

Class BaseAttributeSelector

java.lang.Object

magpie.attributes.selectors.BaseAttributeSelector

All Implemented Interfaces:

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

Direct Known Subclasses:

BestIndividualSelector, ExhaustiveAttributeSelector, PythonBasedAttributeSelector, RegexAttributeSelector, RemoveCorrelatedAttributeSelector, RemoveDuplicateAttributeSelector, RemoveNaNAttributeSelector, StagedAttributeSelector, UserSpecifiedAttributeSelector, WekaAttributeSelector

public abstract class BaseAttributeSelector
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, Options, Printable, Commandable

Interface to select a subset of attributes for a dataset. Implementations must define a method to select a subset of attribute:

• train_protected(magpie.data.Dataset) - Select attributes, return list of their indexes
• Options.setOptions(java.util.List) - Set any options for your implementation. Make sure to make them settable from the Java interface as well.

Implemented Commands:

train $<dataset> - Train an attribute selector. Selects a subset of attributes.
dataset: Dataset used to train selector

run $<dataset> - Reduce number of attributes in a dataset
dataset: Dataset to run selector on

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	trained Whether this BaseAttributeSelector has been trained

Constructor Summary

Constructors

Constructor and Description
BaseAttributeSelector()

Method Summary

Modifier and Type	Method and Description
java.lang.String	about() Prints a simple status message about this object
protected static void	applyAttributeSelection(java.util.List<java.lang.Integer> selectedAttributes, Dataset data) Given a list of attribute IDs, adjust a dataset so that it only has the specified attributes.
BaseAttributeSelector	clone()
java.util.List<java.lang.String>	getSelectionNames() Get the selected attributes
java.util.List<java.lang.Integer>	getSelections() Get the selected attributes
boolean	isTrained()
java.lang.String	printCommand(java.util.List<java.lang.String> Command) Handles more complicated printing commands.
java.lang.String	printDescription(boolean htmlFormat) Print full name of object, and a simple description of the options.
java.lang.String	printSelections() This operation prints out the names of attributes that were selected
void	run(Dataset data) Adjust the attribute list of a dataset, based on a trained selection algorithm
java.lang.Object	runCommand(java.util.List<java.lang.Object> Command) Process some command described by a list of Objects.
protected abstract java.util.List<java.lang.Integer>	train_protected(Dataset Data) Operation that actually does the work for training.
void	train(Dataset Data) Train an attribute selection algorithm on a dataset.

Methods inherited from class java.lang.Object

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

Methods inherited from interface magpie.utility.interfaces.Options

printUsage, setOptions

Field Detail

trained

protected boolean trained

Whether this BaseAttributeSelector has been trained

Constructor Detail

BaseAttributeSelector

public BaseAttributeSelector()

Method Detail

train

public void train(Dataset Data)

Train an attribute selection algorithm on a dataset. Selects which attributes will be used, but does not reduce the dataset (see run(magpie.data.Dataset)).

Parameters:

Data - Data used for training purposes

isTrained

public boolean isTrained()

Returns:

Whether this selector has been trained

train_protected

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

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

Parameters:

Data - Dataset used to train selector

Returns:

List of indexes of selected attributes

getSelections

public java.util.List<java.lang.Integer> getSelections()

Get the selected attributes

Returns:

Indices of the selected attributes

getSelectionNames

public java.util.List<java.lang.String> getSelectionNames()

Get the selected attributes

Returns:

Indices of the selected attributes

run

public void run(Dataset data)

Adjust the attribute list of a dataset, based on a trained selection algorithm

Parameters:

data - Dataset to be filtered

applyAttributeSelection

protected static void applyAttributeSelection(java.util.List<java.lang.Integer> selectedAttributes,
                                              Dataset data)

Given a list of attribute IDs, adjust a dataset so that it only has the specified attributes.

Parameters:

selectedAttributes - List of selected attributes

data - Dataset to be run

clone

public BaseAttributeSelector clone()

Overrides:

clone in class java.lang.Object

printSelections

public java.lang.String printSelections()

This operation prints out the names of attributes that were selected

Returns:

Formatted string containing a table of attribute names

about

public java.lang.String about()

Description copied from interface: Printable

Prints a simple status message about this object

Specified by:

about in interface Printable

Returns:

Short status message

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

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()

printCommand

public java.lang.String printCommand(java.util.List<java.lang.String> Command)
                              throws java.lang.Exception

Description copied from interface: Printable

Handles more complicated printing commands.

Specified by:

printCommand in interface Printable

Parameters:

Command - Command specifying what to print

Returns:

String formatted as requested

Throws:

java.lang.Exception - If command not understood

runCommand

public java.lang.Object runCommand(java.util.List<java.lang.Object> Command)
                            throws java.lang.Exception

Description copied from interface: Commandable

Process some command described by a list of Objects.

Specified by:

runCommand in interface Commandable

Parameters:

Command - Command as a list of objects

Returns:

Any output (null if no output generated by command)

Throws:

java.lang.Exception - If something goes wrong