com.rapidminer.operator.performance
Class BinominalClassificationPerformanceEvaluator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.performance.AbstractPerformanceEvaluator
          com.rapidminer.operator.performance.BinominalClassificationPerformanceEvaluator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class BinominalClassificationPerformanceEvaluator
extends AbstractPerformanceEvaluator

This performance evaluator operator should be used for classification tasks, i.e. in cases where the label attribute has a binominal value type. Other polynominal classification tasks, i.e. tasks with more than two classes can be handled by the PolynominalClassificationPerformanceEvaluator operator. This operator expects a test ExampleSet as input, whose elements have both true and predicted labels, and delivers as output a list of performance values according to a list of performance criteria that it calculates. If an input performance vector was already given, this is used for keeping the performance values.

All of the performance criteria can be switched on using boolean parameters. Their values can be queried by a ProcessLogOperator using the same names. The main criterion is used for comparisons and need to be specified only for processes where performance vectors are compared, e.g. feature selection or other meta optimization process setups. If no other main criterion was selected, the first criterion in the resulting performance vector will be assumed to be the main criterion.

The resulting performance vectors are usually compared with a standard performance comparator which only compares the fitness values of the main criterion. Other implementations than this simple comparator can be specified using the parameter comparator_class. This may for instance be useful if you want to compare performance vectors according to the weighted sum of the individual criteria. In order to implement your own comparator, simply subclass PerformanceComparator. Please note that for true multi-objective optimization usually another selection scheme is used instead of simply replacing the performance comparator.

Author:

Ingo Mierswa

Field Summary

Fields inherited from class com.rapidminer.operator.performance.AbstractPerformanceEvaluator

PARAMETER_COMPARATOR_CLASS, PARAMETER_MAIN_CRITERION, PARAMETER_SKIP_UNDEFINED_LABELS

Constructor Summary

BinominalClassificationPerformanceEvaluator(OperatorDescription description)

Method Summary

protected void	checkCompatibility(ExampleSet exampleSet) Performs a check if this operator can be used for this type of exampel set at all.
protected double[]	getClassWeights(Attribute label) Returns null.
java.util.List<PerformanceCriterion>	getCriteria() Delivers the list of criteria which is able for this operator.

Methods inherited from class com.rapidminer.operator.performance.AbstractPerformanceEvaluator

apply, evaluate, evaluate, getInputClasses, getInputDescription, getOutputClasses, getParameterTypes, init, showComparatorParameter, showCriteriaParameter, showSkipNaNLabelsParameter

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

Constructor Detail

BinominalClassificationPerformanceEvaluator

public BinominalClassificationPerformanceEvaluator(OperatorDescription description)

Method Detail

checkCompatibility

protected void checkCompatibility(ExampleSet exampleSet)
                           throws OperatorException

Description copied from class: AbstractPerformanceEvaluator

Performs a check if this operator can be used for this type of exampel set at all.

Specified by:

checkCompatibility in class AbstractPerformanceEvaluator

Throws:

OperatorException

getClassWeights

protected double[] getClassWeights(Attribute label)
                            throws UndefinedParameterError

Returns null.

Specified by:

getClassWeights in class AbstractPerformanceEvaluator

Throws:

UndefinedParameterError

getCriteria

public java.util.List<PerformanceCriterion> getCriteria()

Description copied from class: AbstractPerformanceEvaluator

Delivers the list of criteria which is able for this operator. Please note that all criteria in the list must be freshly instantiated since no copy is created in different runs of this operator. This is important in order to not mess up the results. This method must not return null but should return an empty list in this case.

Specified by:

getCriteria in class AbstractPerformanceEvaluator