weka.classifiers

Class ParallelMultipleClassifiersCombiner

java.lang.Object

weka.classifiers.AbstractClassifier

weka.classifiers.MultipleClassifiersCombiner

weka.classifiers.ParallelMultipleClassifiersCombiner

All Implemented Interfaces:

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

Direct Known Subclasses:

RandomizableParallelMultipleClassifiersCombiner

public abstract class ParallelMultipleClassifiersCombiner
extends MultipleClassifiersCombiner

Abstract utility class for handling settings common to meta classifiers that build an ensemble in parallel using multiple classifiers.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_completed The number of classifiers completed so far
protected java.util.concurrent.ThreadPoolExecutor	m_executorPool Pool of threads to train models with
protected int	m_failed The number of classifiers that experienced a failure of some sort during construction
protected int	m_numExecutionSlots The number of threads to have executing at any one time

Fields inherited from class weka.classifiers.MultipleClassifiersCombiner

m_Classifiers

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
ParallelMultipleClassifiersCombiner()

Method Summary

Modifier and Type	Method and Description
void	buildClassifier(Instances data) Stump method for building the classifiers
protected void	buildClassifiers(Instances data) Does the actual construction of the ensemble
protected void	completedClassifier(int iteration, boolean success) Records the completion of the training of a single classifier.
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.
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.
protected void	startExecutorPool() Start the pool of execution threads

Methods inherited from class weka.classifiers.MultipleClassifiersCombiner

classifiersTipText, getCapabilities, getClassifier, getClassifiers, getClassifierSpec, postExecution, preExecution, setClassifiers

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

m_executorPool

protected transient java.util.concurrent.ThreadPoolExecutor m_executorPool

Pool of threads to train models with

m_completed

protected int m_completed

The number of classifiers completed so far

m_failed

protected int m_failed

The number of classifiers that experienced a failure of some sort during construction

Constructor Detail

ParallelMultipleClassifiersCombiner

public ParallelMultipleClassifiersCombiner()

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 MultipleClassifiersCombiner

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:

-Z 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 MultipleClassifiersCombiner

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 MultipleClassifiersCombiner

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

Parameters:

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

Throws:

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

startExecutorPool

protected void startExecutorPool()

Start the pool of execution threads

buildClassifiers

protected void buildClassifiers(Instances data)
                         throws java.lang.Exception

Does the actual construction of the ensemble

Throws:

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

completedClassifier

protected void completedClassifier(int iteration,
                                   boolean success)

Records the completion of the training of a single classifier. Unblocks if all classifiers have been trained.

Parameters:

iteration - the iteration that has completed

success - whether the classifier trained successfully