Package weka.classifiers.misc
Class SerializedClassifier
- java.lang.Object
-
- weka.classifiers.Classifier
-
- weka.classifiers.misc.SerializedClassifier
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,CapabilitiesHandler,OptionHandler,RevisionHandler
public class SerializedClassifier extends Classifier
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: 7560 $
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SerializedClassifier()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbuildClassifier(Instances data)loads only the serialized classifierdouble[]distributionForInstance(Instance instance)Calculates the class membership probabilities for the given test instance.CapabilitiesgetCapabilities()Returns default capabilities of the base classifier.ClassifiergetCurrentModel()Gets the currently loaded model (can be null).java.io.FilegetModelFile()Gets the file containing the serialized model.java.lang.String[]getOptions()returns the options of the current setupjava.lang.StringgetRevision()Returns the revision string.java.lang.StringglobalInfo()Returns a string describing classifierjava.util.EnumerationlistOptions()Gets an enumeration describing the available options.static voidmain(java.lang.String[] args)Runs the classifier with the given optionsjava.lang.StringmodelFileTipText()Returns the tip text for this propertyvoidsetModel(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.voidsetModelFile(java.io.File value)Sets the file containing the serialized model.voidsetOptions(java.lang.String[] options)Parses the options for this object.java.lang.StringtoString()Returns a string representation of the classifier-
Methods inherited from class weka.classifiers.Classifier
classifyInstance, debugTipText, forName, getDebug, makeCopies, makeCopy, setDebug
-
-
-
-
Method Detail
-
globalInfo
public java.lang.String globalInfo()
Returns a string describing classifier- Returns:
- a description suitable for displaying in the explorer/experimenter gui
-
listOptions
public java.util.Enumeration listOptions()
Gets an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classClassifier- Returns:
- an enumeration of all the available options.
-
getOptions
public java.lang.String[] getOptions()
returns the options of the current setup- Specified by:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classClassifier- Returns:
- the current options
-
setOptions
public void setOptions(java.lang.String[] options) throws java.lang.ExceptionParses 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:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classClassifier- Parameters:
options- the options to use- Throws:
java.lang.Exception- if setting of options fails
-
modelFileTipText
public java.lang.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 java.io.File getModelFile()
Gets the file containing the serialized model.- Returns:
- the file.
-
setModelFile
public void setModelFile(java.io.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:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classClassifier- Returns:
- the capabilities of the base classifier
- See Also:
Capabilities
-
distributionForInstance
public double[] distributionForInstance(Instance instance) throws java.lang.Exception
Calculates the class membership probabilities for the given test instance.- Overrides:
distributionForInstancein classClassifier- Parameters:
instance- the instance to be classified- Returns:
- preedicted class probability distribution
- Throws:
java.lang.Exception- if distribution can't be computed successfully
-
buildClassifier
public void buildClassifier(Instances data) throws java.lang.Exception
loads only the serialized classifier- Specified by:
buildClassifierin classClassifier- Parameters:
data- the training instances- Throws:
java.lang.Exception- if something goes wrong
-
toString
public java.lang.String toString()
Returns a string representation of the classifier- Overrides:
toStringin classjava.lang.Object- Returns:
- the string representation of the classifier
-
getRevision
public java.lang.String getRevision()
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classClassifier- Returns:
- the revision
-
main
public static void main(java.lang.String[] args)
Runs the classifier with the given options- Parameters:
args- the commandline options
-
-