gov.sandia.cognition.learning.algorithm.ensemble

Class BaggingCategorizerLearner.OutOfBagErrorStoppingCriteria<InputType,CategoryType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.algorithm.event.AbstractIterativeAlgorithmListener

gov.sandia.cognition.learning.algorithm.ensemble.AbstractCategorizerOutOfBagStoppingCriteria<InputType,CategoryType>

gov.sandia.cognition.learning.algorithm.ensemble.BaggingCategorizerLearner.OutOfBagErrorStoppingCriteria<InputType,CategoryType>

Type Parameters:

InputType - The input type the algorithm is learning over.

CategoryType - The category type the algorithm is learning over.

All Implemented Interfaces:

IterativeAlgorithmListener, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Enclosing class:

BaggingCategorizerLearner<InputType,CategoryType>

public static class BaggingCategorizerLearner.OutOfBagErrorStoppingCriteria<InputType,CategoryType>
extends AbstractCategorizerOutOfBagStoppingCriteria<InputType,CategoryType>

Implements a stopping criteria for bagging that uses the out-of-bag error to determine when to stop learning the ensemble. It tracks the out-of-bag error rate of the ensemble and keeps it in a given smoothing window. Once the smoothed error rate stops decreasing, it stops learning and removes all of the ensemble members back to the one that had the minimal error in that window.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<DataDistribution<CategoryType>>	outOfBagEstimates The running estimate of the ensemble for each example where an ensemble member can only vote on elements that were not in the bag used to train it.

Fields inherited from class gov.sandia.cognition.learning.algorithm.ensemble.AbstractCategorizerOutOfBagStoppingCriteria

DEFAULT_SMOOTHING_WINDOW_SIZE, learner, outOfBagCorrect, outOfBagErrorCount, previousSmoothedErrorRate, rawErrorRates, smoothedErrorRates, smoothingBuffer, smoothingWindowSize

Constructor Summary

Constructors

Constructor and Description
OutOfBagErrorStoppingCriteria() Creates a new OutOfBagErrorStoppingCriteria.
OutOfBagErrorStoppingCriteria(int smoothingWindowSize) Creates a new OutOfBagErrorStoppingCriteria with the given smoothing window size.

Method Summary

Modifier and Type	Method and Description
void	algorithmEnded(IterativeAlgorithm algorithm) This method is called when the algorithm has ended, after the last step of the algorithm.
void	algorithmStarted(IterativeAlgorithm algorithm) This method is called when a algorithm has started, before the first step of the algorithm.
DataDistribution<CategoryType>	getOutOfBagEstimate(int index) Gets the out-of-bag estimate distribution across categories for the training example with the given index.
void	stepEnded(IterativeAlgorithm algorithm) This method is called when the algorithm has ended a step of its execution.
protected void	updateOutOfBagEstimates() Updates the out-of-bag estimates that this ensemble keeps.

Methods inherited from class gov.sandia.cognition.learning.algorithm.ensemble.AbstractCategorizerOutOfBagStoppingCriteria

getSmoothingWindowSize, setSmoothingWindowSize

Methods inherited from class gov.sandia.cognition.algorithm.event.AbstractIterativeAlgorithmListener

stepStarted

Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable

clone

Methods inherited from class java.lang.Object

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

Field Detail

outOfBagEstimates

protected transient java.util.ArrayList<DataDistribution<CategoryType>> outOfBagEstimates

The running estimate of the ensemble for each example where an ensemble member can only vote on elements that were not in the bag used to train it. Same size as the training data.

Constructor Detail

OutOfBagErrorStoppingCriteria

public OutOfBagErrorStoppingCriteria()

Creates a new OutOfBagErrorStoppingCriteria.

OutOfBagErrorStoppingCriteria

public OutOfBagErrorStoppingCriteria(int smoothingWindowSize)

Creates a new OutOfBagErrorStoppingCriteria with the given smoothing window size.

Parameters:

smoothingWindowSize - The smoothing window size to use. Must be positive.

Method Detail

algorithmStarted

public void algorithmStarted(IterativeAlgorithm algorithm)

Description copied from interface: IterativeAlgorithmListener

This method is called when a algorithm has started, before the first step of the algorithm.

Specified by:

algorithmStarted in interface IterativeAlgorithmListener

Overrides:

algorithmStarted in class AbstractCategorizerOutOfBagStoppingCriteria<InputType,CategoryType>

Parameters:

algorithm - The algorithm that has started.

algorithmEnded

public void algorithmEnded(IterativeAlgorithm algorithm)

Description copied from interface: IterativeAlgorithmListener

This method is called when the algorithm has ended, after the last step of the algorithm.

Specified by:

algorithmEnded in interface IterativeAlgorithmListener

Overrides:

algorithmEnded in class AbstractCategorizerOutOfBagStoppingCriteria<InputType,CategoryType>

Parameters:

algorithm - The algorithm that has ended.

getOutOfBagEstimate

public DataDistribution<CategoryType> getOutOfBagEstimate(int index)

Description copied from class: AbstractCategorizerOutOfBagStoppingCriteria

Gets the out-of-bag estimate distribution across categories for the training example with the given index.

Specified by:

getOutOfBagEstimate in class AbstractCategorizerOutOfBagStoppingCriteria<InputType,CategoryType>

Parameters:

index - The 0-based index for the training example.

Returns:

The distribution over output categories for the out-of-bag estimate for the example at that index. May be empty.

updateOutOfBagEstimates

protected void updateOutOfBagEstimates()

Updates the out-of-bag estimates that this ensemble keeps.

stepEnded

public void stepEnded(IterativeAlgorithm algorithm)

Description copied from interface: IterativeAlgorithmListener

This method is called when the algorithm has ended a step of its execution.

Specified by:

stepEnded in interface IterativeAlgorithmListener

Overrides:

stepEnded in class AbstractCategorizerOutOfBagStoppingCriteria<InputType,CategoryType>

Parameters:

algorithm - The algorithm that has ended another step of its execution.