com.rapidminer.operator.learner.functions
Class LinearRegression

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.learner.AbstractLearner
          com.rapidminer.operator.learner.functions.LinearRegression

All Implemented Interfaces:

ConfigurationListener, PreviewListener, Learner, ParameterHandler, LoggingHandler

public class LinearRegression
extends AbstractLearner

This operator calculates a linear regression model. It uses the Akaike criterion for model selection.

Author:

Ingo Mierswa

Field Summary

static java.lang.String[]	FEATURE_SELECTION_METHODS Attribute selection methods
static int	GREEDY Attribute selection method: Greedy method
static int	M5_PRIME Attribute selection method: M5 method
static int	NO_SELECTION Attribute selection method: No attribute selection
static java.lang.String	PARAMETER_ELIMINATE_COLINEAR_FEATURES The parameter name for "Indicates if the algorithm should try to delete colinear features during the regression.
static java.lang.String	PARAMETER_FEATURE_SELECTION The parameter name for "The feature selection method used during regression.
static java.lang.String	PARAMETER_MIN_STANDARDIZED_COEFFICIENT The parameter name for "The minimum standardized coefficient for the removal of colinear feature elimination.
static java.lang.String	PARAMETER_RIDGE The parameter name for "The ridge parameter used during ridge regression.
static java.lang.String	PARAMETER_USE_BIAS

Fields inherited from class com.rapidminer.operator.learner.AbstractLearner

PROPERTY_RAPIDMINER_GENERAL_CAPABILITIES_WARN

Constructor Summary

LinearRegression(OperatorDescription description)

Method Summary

java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
Model	learn(ExampleSet exampleSet) Trains a model.
boolean	supportsCapability(LearnerCapability lc) Checks for Learner capabilities.

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

apply, getEstimatedPerformance, getInputClasses, getInputDescription, getOptimizationPerformance, getOutputClasses, getWeights, onlyWarnForNonSufficientCapabilities, shouldCalculateWeights, shouldDeliverOptimizationPerformance, shouldEstimatePerformance

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rapidminer.operator.learner.Learner

getName

Field Detail

PARAMETER_FEATURE_SELECTION

public static final java.lang.String PARAMETER_FEATURE_SELECTION

The parameter name for "The feature selection method used during regression."

See Also:

Constant Field Values

PARAMETER_ELIMINATE_COLINEAR_FEATURES

public static final java.lang.String PARAMETER_ELIMINATE_COLINEAR_FEATURES

The parameter name for "Indicates if the algorithm should try to delete colinear features during the regression."

See Also:

Constant Field Values

PARAMETER_USE_BIAS

public static final java.lang.String PARAMETER_USE_BIAS

See Also:

Constant Field Values

PARAMETER_MIN_STANDARDIZED_COEFFICIENT

public static final java.lang.String PARAMETER_MIN_STANDARDIZED_COEFFICIENT

The parameter name for "The minimum standardized coefficient for the removal of colinear feature elimination."

See Also:

Constant Field Values

PARAMETER_RIDGE

public static final java.lang.String PARAMETER_RIDGE

The parameter name for "The ridge parameter used during ridge regression."

See Also:

Constant Field Values

FEATURE_SELECTION_METHODS

public static final java.lang.String[] FEATURE_SELECTION_METHODS

Attribute selection methods

NO_SELECTION

public static final int NO_SELECTION

Attribute selection method: No attribute selection

See Also:

Constant Field Values

M5_PRIME

public static final int M5_PRIME

Attribute selection method: M5 method

See Also:

Constant Field Values

GREEDY

public static final int GREEDY

Attribute selection method: Greedy method

See Also:

Constant Field Values

Constructor Detail

LinearRegression

public LinearRegression(OperatorDescription description)

Method Detail

learn

public Model learn(ExampleSet exampleSet)
            throws OperatorException

Description copied from interface: Learner

Trains a model. This method should be called by apply() and is implemented by subclasses.

Throws:

OperatorException

supportsCapability

public boolean supportsCapability(LearnerCapability lc)

Description copied from interface: Learner

Checks for Learner capabilities. Should return true if the given capability is supported.

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator