magpie.attributes.generators

Class ModelPredictionAttributeGenerator

java.lang.Object

magpie.attributes.generators.BaseAttributeGenerator

magpie.attributes.generators.ModelPredictionAttributeGenerator

All Implemented Interfaces:

java.io.Serializable, Commandable, Options

public class ModelPredictionAttributeGenerator
extends BaseAttributeGenerator

Use the result from another model as an attribute. User must provide model and dataset used to compute attributes for model.

For regression, the predicted class value will be used as an attribute

For classification, the predicted class and probability of an entry being each class known to the model will be used as attributes. Example: P(Yes)>50%, P(Yes), and P(No) for a binary classification model.

Usage: <name> $<model> $<dataset>
name: Name of model (used to name attributes)
model: Model used to create attributes
dataset: Dataset used to compute attributes for model

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModelPredictionAttributeGenerator()

Method Summary

Modifier and Type	Method and Description
void	addAttributes(Dataset data) Generate new attributes for a dataset.
java.lang.String	printDescription(boolean htmlFormat) Print out description of attributes.
java.lang.String	printUsage() Print out required format for options.
void	setModel(java.lang.String name, BaseModel model, Dataset data) Set the model used to create attribute(s).
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.

Methods inherited from class magpie.attributes.generators.BaseAttributeGenerator

runCommand

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelPredictionAttributeGenerator

public ModelPredictionAttributeGenerator()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                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:

Options - 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

setModel

public void setModel(java.lang.String name,
                     BaseModel model,
                     Dataset data)
              throws java.lang.Exception

Set the model used to create attribute(s). Define both the model and dataset used to create attributes.

Parameters:

name - Name of model. Used to create unique attribute names.

model - Model to evaluate. Will be cloned

data - Dataset used to generate attributes for that model. Will be cloned

Throws:

java.lang.Exception - If model not trained

addAttributes

public void addAttributes(Dataset data)
                   throws java.lang.Exception

Description copied from class: BaseAttributeGenerator

Generate new attributes for a dataset. This operation must both add the new attribute names to the dataset and new values to each entry.

Specified by:

addAttributes in class BaseAttributeGenerator

Parameters:

data - Dataset to be added to

Throws:

java.lang.Exception

See Also:

Dataset.addAttribute(java.lang.String, double[])

printDescription

public java.lang.String printDescription(boolean htmlFormat)

Description copied from class: BaseAttributeGenerator

Print out description of attributes.

Implementation Notes

Format should look like

[Full Name of generator]: (Number of attributes) Text description of what these attributes are

For HTML format, omit the ":".

Specified by:

printDescription in class BaseAttributeGenerator

Parameters:

htmlFormat - Whether to print in HTML format

Returns:

Description of the attributes