magpie.models.classification

Class SplitClassifier

java.lang.Object

magpie.models.BaseModel

magpie.models.SplitModel

magpie.models.classification.SplitClassifier

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, AbstractClassifier, MultiModel, Citable, Commandable, Options, Printable, Savable

public class SplitClassifier
extends SplitModel
implements AbstractClassifier

Model that uses several other models to model different parts of a dataset.

How to Use this Class

Use this class in the same way as you would use any SplitModel.

Usage: *No options*

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	ClassNames Names of classes this model can distinguish between
protected int	NClasses Number of classes model can distinguish between
protected ClassificationStatistics	TrainingStatsPtr Pointer to ClassificationStatistics interface of TrainingStats
protected ClassificationStatistics	ValidationStatsPtr Pointer to ClassificationStatistics interface of ValidationStates

Fields inherited from class magpie.models.SplitModel

GenericModel, Model, Partitioner

Fields inherited from class magpie.models.BaseModel

AttributeSelector, trained, TrainingStats, validated, ValidationStats

Constructor Summary

Constructors

Constructor and Description
SplitClassifier() Create a blank SplitClassifier

Method Summary

Modifier and Type	Method and Description
SplitClassifier	clone()
java.lang.String[]	getClassNames() Get names of classes this model distinguishes between.
int	getNClasses()
void	run_protected(Dataset Data) Run a model without checking if stuff is trained (use carefully)
void	setGenericModel(BaseModel x) Set the model template
void	setModel(int index, BaseModel x) Set a specific submodel.
void	setOptions(java.util.List Options) Set any options for this object.
protected void	train_protected(Dataset TrainingData) Train a model without evaluating performance

Methods inherited from class magpie.models.SplitModel

checkModelCount, getCitations, getGenericModel, getModel, NModels, printCommand, printModel_protected, printModelDescriptionDetails, printUsage, runCommand, setNumberOfModels, setPartitioner

Methods inherited from class magpie.models.BaseModel

about, crossValidate, crossValidate, crossValidate, done, externallyValidate, getAttributeSelector, getFilter, getTrainTime, getValidationMethod, handleSetCommand, isTrained, isValidated, loadState, printDescription, printModel, resetModel, run, saveCommand, saveState, setAttributeSelector, setComponent, setFilter, train, train

Methods inherited from class java.lang.Object

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

Field Detail

TrainingStatsPtr

protected ClassificationStatistics TrainingStatsPtr

Pointer to ClassificationStatistics interface of TrainingStats

ValidationStatsPtr

protected ClassificationStatistics ValidationStatsPtr

Pointer to ClassificationStatistics interface of ValidationStates

NClasses

protected int NClasses

Number of classes model can distinguish between

ClassNames

protected java.lang.String[] ClassNames

Names of classes this model can distinguish between

Constructor Detail

SplitClassifier

public SplitClassifier()

Create a blank SplitClassifier

Method Detail

setOptions

public void setOptions(java.util.List Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Specified by:

setOptions in interface Options

Overrides:

setOptions in class SplitModel

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

setModel

public void setModel(int index,
                     BaseModel x)

Description copied from interface: MultiModel

Set a specific submodel. Will increase number of models if necessary.

Any implementation should not clone the model. This will allow people to construct a model used already-trained models.

Specified by:

setModel in interface MultiModel

Overrides:

setModel in class SplitModel

Parameters:

index - Index of submodel to be set

x - Model to be used (creates a clone)

setGenericModel

public void setGenericModel(BaseModel x)

Description copied from class: SplitModel

Set the model template

Specified by:

setGenericModel in interface MultiModel

Overrides:

setGenericModel in class SplitModel

Parameters:

x - Template model (will be cloned)

clone

public SplitClassifier clone()

Overrides:

clone in class SplitModel

getNClasses

public int getNClasses()

Specified by:

getNClasses in interface AbstractClassifier

Returns:

Number of classes model will distinguish between

getClassNames

public java.lang.String[] getClassNames()

Description copied from interface: AbstractClassifier

Get names of classes this model distinguishes between.

Specified by:

getClassNames in interface AbstractClassifier

Returns:

Names of classes

train_protected

protected void train_protected(Dataset TrainingData)

Description copied from class: BaseModel

Train a model without evaluating performance

Overrides:

train_protected in class SplitModel

Parameters:

TrainingData - Training data

run_protected

public void run_protected(Dataset Data)

Description copied from class: BaseModel

Run a model without checking if stuff is trained (use carefully)

Overrides:

run_protected in class SplitModel

Parameters:

Data - Training data