com.rapidminer.operator
Interface Model

All Superinterfaces:

IOObject, Readable, Reportable, ResultObject, java.io.Serializable

All Known Subinterfaces:

FormulaProvider, ViewModel

All Known Implementing Classes:

AbstractEigenvectorModel, AbstractModel, AbstractMySVMModel, AbstractNormalizationModel, AdaBoostModel, AdditiveRegressionModel, AttributeBasedVotingModel, AttributeDefaultModel, BaggingModel, BayBoostModel, Binary2MultiClassModel, CentroidClusterModel, ClusterModel, ConjunctiveRuleModel, DefaultModel, Dictionary, DimensionalityReducerModel, DiscretizationModel, DiscriminantModel, DistributionModel, EvoSVMModel, FastICAModel, FastMarginModel, FlatFuzzyClusterModel, GHAModel, GPModel, GroupedModel, GSSModel, HierarchicalModel, HierarchicalMultiClassModel, HyperModel, HyperplaneModel, ImprovedNeuralNetModel, IQRNormalizationModel, JMySVMModel, KernelDistributionModel, KernelLogisticRegressionModel, KernelModel, KernelPCAModel, KNNClassificationModel, KNNRegressionModel, LibSVMModel, LinearMySVMModel, LinearRegressionModel, LocalPolynomialRegressionModel, LogisticRegressionModel, MetaCostModel, MinMaxNormalizationModel, MultiCriterionDecisionStumps.DecisionStumpModel, MultiModelByRegression, MyKLRModel, NeuralNetModel, NoiseModel, NominalToBinominalModel, PCAModel, PlattScalingModel, PolynomialRegressionModel, PredictionModel, PreprocessingModel, ProportionNormalizationModel, RandomForestModel, RelativeRegressionModel, RuleModel, RuleSet, RVMModel, SDEnsemble, SeeminglyUnrelatedRegressionModel, SimpleBinaryPredictionModel, SimpleDistributionModel, SimpleNeuralNetModel, SimplePredictionModel, SimpleVoteModel, SOMDimensionalityReductionModel, StackingModel, ThresholdModel, TransformedRegressionModel, TreeModel, UpdateablePredictionModel, ValueReplenishmentModel, VectorRegressionModel, ZTransformationModel

public interface Model
extends ResultObject, Readable

Model is the interface for all objects which change a data set. For example, a model generated by a learner might add a predicted attribute. Other models can be created during preprocessing, e.g. a transformation model containing the parameters for a z-transformation. Models can be combined by using a GroupedModel. Please note that all models will automatically wrapped into a ContainerModel if they are not already part of it. All models can be applied with a ModelApplier operator.

Author:

Ingo Mierswa

Method Summary

ExampleSet	apply(ExampleSet testSet) Applies the model on the given example set.
HeaderExampleSet	getTrainingHeader() This method has to return the HeaderExampleSet containing the signature of the example set during training time containing all informations about attributes.
boolean	isUpdatable() Returns true if this model is updatable.
void	setParameter(java.lang.String key, java.lang.Object value) This method can be used to allow additional parameters.
void	updateModel(ExampleSet updateExampleSet) Updates the model according to the given example set.

Methods inherited from interface com.rapidminer.operator.ResultObject

getActions, getName, getResultIcon, toResultString

Methods inherited from interface com.rapidminer.operator.IOObject

appendOperatorToHistory, copy, getAnnotations, getLog, getProcessingHistory, getSource, setLoggingHandler, setSource, write

Methods inherited from interface com.rapidminer.report.Readable

isInTargetEncoding, toString

Method Detail

getTrainingHeader

HeaderExampleSet getTrainingHeader()

This method has to return the HeaderExampleSet containing the signature of the example set during training time containing all informations about attributes. This is important for checking the compatibility of the examples on application time. Note that the AbstractModel already implements all necessary functionality.

apply

ExampleSet apply(ExampleSet testSet)
                 throws OperatorException

Applies the model on the given example set. Please note that the delivered example set might be the same as the input example set. This does, however, no always to be the case.

Throws:

OperatorException

setParameter

void setParameter(java.lang.String key,
                  java.lang.Object value)
                  throws OperatorException

This method can be used to allow additional parameters. Most models do not support parameters during application.

Throws:

OperatorException

isUpdatable

boolean isUpdatable()

Returns true if this model is updatable. Please note that only models which return true here must implement the method updateModel(ExampleSet).

updateModel

void updateModel(ExampleSet updateExampleSet)
                 throws OperatorException

Updates the model according to the given example set. This method might throw an UserError if the model is not updatable. In that case the method isUpdatable() should deliver false.

Throws:

OperatorException