com.rapidminer.operator.learner.functions
Class LogisticRegression

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

All Implemented Interfaces:

ConfigurationListener, PreviewListener, Learner, ParameterHandler, LoggingHandler

public class LogisticRegression
extends AbstractLearner

This operator determines a logistic regression model.

Author:

Ingo Mierswa, Tobias Malbrecht

Field Summary

static java.lang.String	PARAMETER_ADD_INTERCEPT The parameter name for "Determines whether to include an intercept.
static java.lang.String	PARAMETER_CROSSOVER_PROB The parameter name for "The probability for crossovers.
static java.lang.String	PARAMETER_GENERATIONS_WITHOUT_IMPROVAL The parameter name for "Stop after this number of generations without improvement (-1: optimize until max_iterations).
static java.lang.String	PARAMETER_KEEP_BEST The parameter name for "Indicates if the best individual should survive (elititst selection).
static java.lang.String	PARAMETER_LOCAL_RANDOM_SEED The parameter name for "Use the given random seed instead of global random numbers (-1: use global).
static java.lang.String	PARAMETER_MAX_GENERATIONS The parameter name for "Stop after this many evaluations"
static java.lang.String	PARAMETER_MUTATION_TYPE The parameter name for "The type of the mutation operator.
static java.lang.String	PARAMETER_POPULATION_SIZE The parameter name for "The population size (-1: number of examples)"
static java.lang.String	PARAMETER_RETURN_PERFORMANCE The parameter name for "Determines whether to return the performance.
static java.lang.String	PARAMETER_SELECTION_TYPE The parameter name for "The type of the selection operator.
static java.lang.String	PARAMETER_SHOW_CONVERGENCE_PLOT The parameter name for "Indicates if a dialog with a convergence plot should be drawn.
static java.lang.String	PARAMETER_START_POPULATION_TYPE The parameter name for "The type of start population initialization.
static java.lang.String	PARAMETER_TOURNAMENT_FRACTION The parameter name for "The fraction of the population used for tournament selection.

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

PROPERTY_RAPIDMINER_GENERAL_CAPABILITIES_WARN

Constructor Summary

LogisticRegression(OperatorDescription description)

Method Summary

PerformanceVector	getEstimatedPerformance() Returns the estimated performance.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
Model	learn(ExampleSet exampleSet) Trains a model.
boolean	shouldEstimatePerformance() Returns true if the user wants to estimate the performance (depending on a parameter).
boolean	supportsCapability(LearnerCapability lc) Checks for Learner capabilities.

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

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

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_ADD_INTERCEPT

public static final java.lang.String PARAMETER_ADD_INTERCEPT

The parameter name for "Determines whether to include an intercept."

See Also:

Constant Field Values

PARAMETER_RETURN_PERFORMANCE

public static final java.lang.String PARAMETER_RETURN_PERFORMANCE

The parameter name for "Determines whether to return the performance."

See Also:

Constant Field Values

PARAMETER_START_POPULATION_TYPE

public static final java.lang.String PARAMETER_START_POPULATION_TYPE

The parameter name for "The type of start population initialization."

See Also:

Constant Field Values

PARAMETER_MAX_GENERATIONS

public static final java.lang.String PARAMETER_MAX_GENERATIONS

The parameter name for "Stop after this many evaluations"

See Also:

Constant Field Values

PARAMETER_GENERATIONS_WITHOUT_IMPROVAL

public static final java.lang.String PARAMETER_GENERATIONS_WITHOUT_IMPROVAL

The parameter name for "Stop after this number of generations without improvement (-1: optimize until max_iterations)."

See Also:

Constant Field Values

PARAMETER_POPULATION_SIZE

public static final java.lang.String PARAMETER_POPULATION_SIZE

The parameter name for "The population size (-1: number of examples)"

See Also:

Constant Field Values

PARAMETER_TOURNAMENT_FRACTION

public static final java.lang.String PARAMETER_TOURNAMENT_FRACTION

The parameter name for "The fraction of the population used for tournament selection."

See Also:

Constant Field Values

PARAMETER_KEEP_BEST

public static final java.lang.String PARAMETER_KEEP_BEST

The parameter name for "Indicates if the best individual should survive (elititst selection)."

See Also:

Constant Field Values

PARAMETER_MUTATION_TYPE

public static final java.lang.String PARAMETER_MUTATION_TYPE

The parameter name for "The type of the mutation operator."

See Also:

Constant Field Values

PARAMETER_SELECTION_TYPE

public static final java.lang.String PARAMETER_SELECTION_TYPE

The parameter name for "The type of the selection operator."

See Also:

Constant Field Values

PARAMETER_CROSSOVER_PROB

public static final java.lang.String PARAMETER_CROSSOVER_PROB

The parameter name for "The probability for crossovers."

See Also:

Constant Field Values

PARAMETER_LOCAL_RANDOM_SEED

public static final java.lang.String PARAMETER_LOCAL_RANDOM_SEED

The parameter name for "Use the given random seed instead of global random numbers (-1: use global)."

See Also:

Constant Field Values

PARAMETER_SHOW_CONVERGENCE_PLOT

public static final java.lang.String PARAMETER_SHOW_CONVERGENCE_PLOT

The parameter name for "Indicates if a dialog with a convergence plot should be drawn."

See Also:

Constant Field Values

Constructor Detail

LogisticRegression

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

shouldEstimatePerformance

public boolean shouldEstimatePerformance()

Description copied from class: AbstractLearner

Returns true if the user wants to estimate the performance (depending on a parameter). In this case the method getEstimatedPerformance() must also be overriden and deliver the estimated performance. The default implementation returns false.

Specified by:

shouldEstimatePerformance in interface Learner

Overrides:

shouldEstimatePerformance in class AbstractLearner

getEstimatedPerformance

public PerformanceVector getEstimatedPerformance()
                                          throws OperatorException

Description copied from class: AbstractLearner

Returns the estimated performance. Subclasses which supports the capability to estimate the learning performance must override this method. The default implementation throws an exception.

Specified by:

getEstimatedPerformance in interface Learner

Overrides:

getEstimatedPerformance in class AbstractLearner

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