com.rapidminer.operator.learner.lazy
Class KNNLearner

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.learner.AbstractLearner
          com.rapidminer.operator.learner.lazy.KNNLearner

All Implemented Interfaces:

ConfigurationListener, PreviewListener, Learner, ParameterHandler, LoggingHandler

public class KNNLearner
extends AbstractLearner

A k nearest neighbor implementation.

Author:

Sebastian Land

Field Summary

static java.lang.String	PARAMETER_K The parameter name for "The used number of nearest neighbors.
static java.lang.String	PARAMETER_WEIGHTED_VOTE The parameter name for "Indicates if the votes should be weighted by similarity.

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

PROPERTY_RAPIDMINER_GENERAL_CAPABILITIES_WARN

Constructor Summary

KNNLearner(OperatorDescription description)

Method Summary

InputDescription	getInputDescription(java.lang.Class cls) Indicates that the consumption of example sets can be user defined.
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, 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_K

public static final java.lang.String PARAMETER_K

The parameter name for "The used number of nearest neighbors."

See Also:

Constant Field Values

PARAMETER_WEIGHTED_VOTE

public static final java.lang.String PARAMETER_WEIGHTED_VOTE

The parameter name for "Indicates if the votes should be weighted by similarity."

See Also:

Constant Field Values

Constructor Detail

KNNLearner

public KNNLearner(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.

getInputDescription

public InputDescription getInputDescription(java.lang.Class cls)

Description copied from class: AbstractLearner

Indicates that the consumption of example sets can be user defined.

Overrides:

getInputDescription in class AbstractLearner

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