com.rapidminer.operator.learner.functions
Class VectorLinearRegression

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

All Implemented Interfaces:

ConfigurationListener, PreviewListener, Learner, ParameterHandler, LoggingHandler

public class VectorLinearRegression
extends AbstractLearner

This operator performs a vector linear regression. It regresses all regular attributes upon a vector of labels. The attributes forming the vector have to be marked as special, the special role names of all label attributes have to start with label.

Author:

Tobias Malbrecht

Field Summary

static java.lang.String	PARAMETER_RIDGE
static java.lang.String	PARAMETER_USE_BIAS

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

PROPERTY_RAPIDMINER_GENERAL_CAPABILITIES_WARN

Constructor Summary

VectorLinearRegression(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_USE_BIAS

public static final java.lang.String PARAMETER_USE_BIAS

See Also:

Constant Field Values

PARAMETER_RIDGE

public static final java.lang.String PARAMETER_RIDGE

See Also:

Constant Field Values

Constructor Detail

VectorLinearRegression

public VectorLinearRegression(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