weka.classifiers

Class ParallelIteratedSingleClassifierEnhancer

java.lang.Object

weka.classifiers.AbstractClassifier

weka.classifiers.SingleClassifierEnhancer

weka.classifiers.IteratedSingleClassifierEnhancer

weka.classifiers.ParallelIteratedSingleClassifierEnhancer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Classifier, BatchPredictor, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler

Direct Known Subclasses:

RandomizableParallelIteratedSingleClassifierEnhancer

public abstract class ParallelIteratedSingleClassifierEnhancer
extends IteratedSingleClassifierEnhancer

Abstract utility class for handling settings common to meta classifiers that build an ensemble in parallel from a single base learner.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_numExecutionSlots The number of threads to have executing at any one time

Fields inherited from class weka.classifiers.IteratedSingleClassifierEnhancer

m_Classifiers, m_NumIterations

Fields inherited from class weka.classifiers.SingleClassifierEnhancer

m_Classifier

Fields inherited from class weka.classifiers.AbstractClassifier

BATCH_SIZE_DEFAULT, m_BatchSize, m_Debug, m_DoNotCheckCapabilities, m_numDecimalPlaces, NUM_DECIMAL_PLACES_DEFAULT

Constructor Summary

Constructors

Constructor and Description
ParallelIteratedSingleClassifierEnhancer()

Method Summary

Modifier and Type	Method and Description
void	buildClassifier(Instances data) Stump method for building the classifiers
protected void	buildClassifiers() Does the actual construction of the ensemble
int	getNumExecutionSlots() Get the number of execution slots (threads) to use for building the members of the ensemble.
java.lang.String[]	getOptions() Gets the current settings of the classifier.
protected abstract Instances	getTrainingSet(int iteration) Gets a training set for a particular iteration.
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
java.lang.String	numExecutionSlotsTipText() Returns the tip text for this property
void	setNumExecutionSlots(int numSlots) Set the number of execution slots (threads) to use for building the members of the ensemble.
void	setOptions(java.lang.String[] options) Parses a given list of options.

Methods inherited from class weka.classifiers.IteratedSingleClassifierEnhancer

defaultNumberOfIterations, getNumIterations, numIterationsTipText, setNumIterations

Methods inherited from class weka.classifiers.SingleClassifierEnhancer

classifierTipText, defaultClassifierOptions, defaultClassifierString, getCapabilities, getClassifier, getClassifierSpec, postExecution, preExecution, setClassifier

Methods inherited from class weka.classifiers.AbstractClassifier

batchSizeTipText, classifyInstance, debugTipText, distributionForInstance, distributionsForInstances, doNotCheckCapabilitiesTipText, forName, getBatchSize, getDebug, getDoNotCheckCapabilities, getNumDecimalPlaces, getRevision, implementsMoreEfficientBatchPrediction, makeCopies, makeCopy, numDecimalPlacesTipText, run, runClassifier, setBatchSize, setDebug, setDoNotCheckCapabilities, setNumDecimalPlaces

Methods inherited from class java.lang.Object

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

Field Detail

m_numExecutionSlots

protected int m_numExecutionSlots

The number of threads to have executing at any one time

Constructor Detail

ParallelIteratedSingleClassifierEnhancer

public ParallelIteratedSingleClassifierEnhancer()

Method Detail

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class IteratedSingleClassifierEnhancer

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options. Valid options are:

-num-slots num
Set the number of execution slots to use (default 1 - i.e. no parallelism).

Options after -- are passed to the designated classifier.

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class IteratedSingleClassifierEnhancer

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the classifier.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class IteratedSingleClassifierEnhancer

Returns:

an array of strings suitable for passing to setOptions

setNumExecutionSlots

public void setNumExecutionSlots(int numSlots)

Set the number of execution slots (threads) to use for building the members of the ensemble.

Parameters:

numSlots - the number of slots to use.

getNumExecutionSlots

public int getNumExecutionSlots()

Get the number of execution slots (threads) to use for building the members of the ensemble.

Returns:

the number of slots to use

numExecutionSlotsTipText

public java.lang.String numExecutionSlotsTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

buildClassifier

public void buildClassifier(Instances data)
                     throws java.lang.Exception

Stump method for building the classifiers

Specified by:

buildClassifier in interface Classifier

Overrides:

buildClassifier in class IteratedSingleClassifierEnhancer

Parameters:

data - the training data to be used for generating the ensemble

Throws:

java.lang.Exception - if the classifier could not be built successfully

buildClassifiers

protected void buildClassifiers()
                         throws java.lang.Exception

Does the actual construction of the ensemble

Throws:

java.lang.Exception - if something goes wrong during the training process

getTrainingSet

protected abstract Instances getTrainingSet(int iteration)
                                     throws java.lang.Exception

Gets a training set for a particular iteration. Implementations need to be careful with thread safety and should probably be synchronized to be on the safe side.

Parameters:

iteration - the number of the iteration for the requested training set

Returns:

the training set for the supplied iteration number

Throws:

java.lang.Exception - if something goes wrong.