com.rapidminer.operator.learner.meta
Class SDEnsemble

java.lang.Object
  com.rapidminer.operator.AbstractIOObject
      com.rapidminer.operator.ResultObjectAdapter
          com.rapidminer.operator.AbstractModel
              com.rapidminer.operator.learner.PredictionModel
                  com.rapidminer.operator.learner.meta.SDEnsemble

All Implemented Interfaces:

IOObject, Model, ResultObject, Saveable, Readable, Reportable, LoggingHandler, java.io.Serializable

public class SDEnsemble
extends PredictionModel

A subgroup discovery model.

Author:

Martin Scholz

See Also:

Serialized Form

Field Summary

static short	RULE_COMBINE_ADDITIVE
static short	RULE_COMBINE_MULTIPLY

Constructor Summary

SDEnsemble(ExampleSet exampleSet, java.util.List modelInfo, double[] priors, short combinationMethod)

Method Summary

protected Attribute	createPredictedLabel(ExampleSet exampleSet) Creates a predicted label with the given name.
Model	getModel(int index) Getter method for embedded models
int	getNumberOfModels()
java.awt.Component	getVisualizationComponent(IOContainer container) Returns a editor pane that displays the ResultObjectAdapter.toResultString() result encoded as html.
ExampleSet	performPrediction(ExampleSet exampleSet, Attribute predictedLabelAttribute) Iterates over all models and returns the class with maximum likelihood.
void	setParameter(java.lang.String name, java.lang.String value) Setting the parameter MAX_MODEL_NUMBER allows to discard all but the first n models for specified n.
java.lang.String	toString()

Methods inherited from class com.rapidminer.operator.learner.PredictionModel

apply, checkCompatibility, copyPredictedLabel, createPredictedLabel, getLabel, removePredictedLabel, removePredictedLabel

Methods inherited from class com.rapidminer.operator.AbstractModel

getExtension, getFileDescription, getName, getResultIcon, getTrainingHeader, isUpdatable, setParameter, updateModel

Methods inherited from class com.rapidminer.operator.ResultObjectAdapter

addAction, getActions, isSavable, log, logError, logNote, logWarning, save, toHTML, toResultString

Methods inherited from class com.rapidminer.operator.AbstractIOObject

copy, getLog, getSource, initWriting, read, setLoggingHandler, setSource, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rapidminer.operator.ResultObject

getActions, toResultString

Methods inherited from interface com.rapidminer.operator.IOObject

copy, getLog, getSource, setLoggingHandler, setSource, write

Methods inherited from interface com.rapidminer.operator.Saveable

isSavable, save

Field Detail

RULE_COMBINE_ADDITIVE

public static final short RULE_COMBINE_ADDITIVE

See Also:

Constant Field Values

RULE_COMBINE_MULTIPLY

public static final short RULE_COMBINE_MULTIPLY

See Also:

Constant Field Values

Constructor Detail

SDEnsemble

public SDEnsemble(ExampleSet exampleSet,
                  java.util.List modelInfo,
                  double[] priors,
                  short combinationMethod)

Parameters:

exampleSet - the example set used for training

modelInfo - a List of Object[2] arrays, each entry holding a model and a double[][] array containing weights for all prediction/label combinations.

priors - an array of the prior probabilities of labels

Method Detail

getVisualizationComponent

public java.awt.Component getVisualizationComponent(IOContainer container)

Description copied from class: ResultObjectAdapter

Returns a editor pane that displays the ResultObjectAdapter.toResultString() result encoded as html. Please note that the returned pane is already enclosed by a scroll pane. If you overwrite this method you should again ensure that the returned component is scrollable. The given container is totally ignored.

Specified by:

getVisualizationComponent in interface ResultObject

Overrides:

getVisualizationComponent in class ResultObjectAdapter

toString

public java.lang.String toString()

Specified by:

toString in interface Readable

Overrides:

toString in class PredictionModel

Returns:

a String representation of the ruleset.

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
                  throws OperatorException

Setting the parameter MAX_MODEL_NUMBER allows to discard all but the first n models for specified n. PRED_TO_FILE requires a filename on the local disk system the predictions of the single classifiers are written to. print_to_stdout prints some statistics about the base classifiers to the standard output.

Throws:

OperatorException

getNumberOfModels

public int getNumberOfModels()

Returns:

the number of embedded models

getModel

public Model getModel(int index)

Getter method for embedded models

Parameters:

index - the number of a model part of this boost model

Returns:

binary or nominal decision model for the given classification index.

performPrediction

public ExampleSet performPrediction(ExampleSet exampleSet,
                                    Attribute predictedLabelAttribute)
                             throws OperatorException

Iterates over all models and returns the class with maximum likelihood.

Specified by:

performPrediction in class PredictionModel

Parameters:

exampleSet - the set of examples to be classified

Throws:

OperatorException

createPredictedLabel

protected Attribute createPredictedLabel(ExampleSet exampleSet)

Creates a predicted label with the given name. If name is null, the name "prediction(labelname)" is used.