Package weka.classifiers.misc

Class SerializedClassifier

java.lang.Object

weka.classifiers.AbstractClassifier

weka.classifiers.misc.SerializedClassifier

All Implemented Interfaces:

Serializable, Cloneable, Classifier, BatchPredictor, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler

public class SerializedClassifier
extends AbstractClassifier

A wrapper around a serialized classifier model. This classifier loads a serialized models and uses it to make predictions.

Warning: since the serialized model doesn't get changed, cross-validation cannot bet used with this classifier.

Valid options are:

 -D
  If set, classifier is run in debug mode and
  may output additional info to the console
 

 -model <filename>
  The file containing the serialized model.
  (required)
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class weka.classifiers.AbstractClassifier

BATCH_SIZE_DEFAULT, NUM_DECIMAL_PLACES_DEFAULT

Constructor Summary

Constructors

Constructor	Description
SerializedClassifier()

Method Summary

Modifier and Type	Method	Description
void	buildClassifier(Instances data)	loads only the serialized classifier
double[]	distributionForInstance(Instance instance)	Calculates the class membership probabilities for the given test instance.
Capabilities	getCapabilities()	Returns default capabilities of the base classifier.
Classifier	getCurrentModel()	Gets the currently loaded model (can be null).
File	getModelFile()	Gets the file containing the serialized model.
String[]	getOptions()	returns the options of the current setup
String	getRevision()	Returns the revision string.
String	globalInfo()	Returns a string describing classifier
Enumeration<Option>	listOptions()	Gets an enumeration describing the available options.
static void	main(String[] args)	Runs the classifier with the given options
String	modelFileTipText()	Returns the tip text for this property
void	setModel(Classifier value)	Sets the fully built model to use, if one doesn't want to load a model from a file or already deserialized a model from somewhere else.
void	setModelFile(File value)	Sets the file containing the serialized model.
void	setOptions(String[] options)	Parses the options for this object.
String	toString()	Returns a string representation of the classifier

Methods inherited from class weka.classifiers.AbstractClassifier

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SerializedClassifier

public SerializedClassifier()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing classifier

Returns:

a description suitable for displaying in the explorer/experimenter gui

listOptions

public Enumeration<Option> listOptions()

Gets an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class AbstractClassifier

Returns:

an enumeration of all the available options.

getOptions

public String[] getOptions()

returns the options of the current setup

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class AbstractClassifier

Returns:

the current options

setOptions

public void setOptions(String[] options)
                throws Exception

Parses the options for this object.

Valid options are:

 -D
  If set, classifier is run in debug mode and
  may output additional info to the console
 

 -model <filename>
  The file containing the serialized model.
  (required)
 

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class AbstractClassifier

Parameters:

options - the options to use

Throws:

Exception - if setting of options fails

modelFileTipText

public String modelFileTipText()

Returns the tip text for this property

Returns:

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

getModelFile

public File getModelFile()

Gets the file containing the serialized model.

Returns:

the file.

setModelFile

public void setModelFile(File value)

Sets the file containing the serialized model.

Parameters:

value - the file.

setModel

public void setModel(Classifier value)

Sets the fully built model to use, if one doesn't want to load a model from a file or already deserialized a model from somewhere else.

Parameters:

value - the built model

See Also:

getCurrentModel()

getCurrentModel

public Classifier getCurrentModel()

Gets the currently loaded model (can be null). Call buildClassifier method to load model from file.

Returns:

the current model

See Also:

setModel(Classifier)

getCapabilities

public Capabilities getCapabilities()

Returns default capabilities of the base classifier.

Specified by:

getCapabilities in interface CapabilitiesHandler

Specified by:

getCapabilities in interface Classifier

Overrides:

getCapabilities in class AbstractClassifier

Returns:

the capabilities of the base classifier

See Also:

Capabilities

distributionForInstance

public double[] distributionForInstance(Instance instance)
                                 throws Exception

Calculates the class membership probabilities for the given test instance.

Specified by:

distributionForInstance in interface Classifier

Overrides:

distributionForInstance in class AbstractClassifier

Parameters:

instance - the instance to be classified

Returns:

preedicted class probability distribution

Throws:

Exception - if distribution can't be computed successfully

buildClassifier

public void buildClassifier(Instances data)
                     throws Exception

loads only the serialized classifier

Parameters:

data - the training instances

Throws:

Exception - if something goes wrong

toString

public String toString()

Returns a string representation of the classifier

Overrides:

toString in class Object

Returns:

the string representation of the classifier

getRevision

public String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class AbstractClassifier

Returns:

the revision

main

public static void main(String[] args)

Runs the classifier with the given options

Parameters:

args - the commandline options