SplitModel (magpie API)

java.lang.Object
- magpie.models.BaseModel
- - magpie.models.SplitModel

All Implemented Interfaces:

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

Direct Known Subclasses:

SplitClassifier, SplitRegression
```
public abstract class SplitModel
extends BaseModel
implements MultiModel
```
Abstract class for a model that splits the dataset and trains several submodels. It contains functions necessary to do this partitioning and keep track of the submodels.
How to Use a SplitModel
SplitModels work by first partitioning a Dataset using a BaseDatasetSplitter and then training several models
Usage: *No options to set*
Implemented Commands:
splitter <method> [<options...>] - Define splitter used to partition dataset between models
method: Method used to split data. Name of a BaseDatasetSplitter ("?" for options)
options: Any options for the splitter
submodel - Print the number of submodels
submodel set generic $<model> - Define a model template to use for all submodels
model: An instance of BaseModel. Note: Do not use this command for CompositeRegression unless each model automatically uses a different random number seed. Otherwise, each submodel will be identical.
submodel set <number> $<model> - Set a specific submodel
number: Index of the submodel to set (list starts with 0)
model: An instance of BaseModel to use for that model
submodel get generic = <output> - Retrieve the template for any unassigned submodels
submodel get <number> = <output> - Retrieve a specific submodel
number: Index of submodel to retrieve (list starts with 0) Returns a clone of the model - you cannot use this to edit the model.
Implemented Print Commands:
splitter - Print out the name of splitter used by this model
submodel - Print out number of submodels
submodel <number> [<command...>] - Pass a print command to one of the submodels
number: Index of model to operate on (starts at 0)
command: Print command that gets passed to that submodel

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected BaseModel`	`GenericModel` Model used to if a model template for a certain split is not defined
`protected java.util.ArrayList<BaseModel>`	`Model` List of of models used by this model
`protected BaseDatasetSplitter`	`Partitioner` Class used to partition data into similar groups

Fields inherited from class magpie.models.BaseModel
AttributeSelector, trained, TrainingStats, validated, ValidationStats

Constructor Summary

Constructors
Constructor and Description

SplitModel()

Constructors
Constructor and Description
`SplitModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkModelCount(int n)` Checks if enough models are defined.
`SplitModel`	`clone()`
`java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,Citation>>`	`getCitations()` Return a list of citations for this object and any underlying objects.
`BaseModel`	`getGenericModel()` Get the model template
`BaseModel`	`getModel(int index)` Get a specific submodel.
`int`	`NModels()` Returns the number of model slots currently available
`java.lang.String`	`printCommand(java.util.List<java.lang.String> Command)` Handles more complicated printing commands.
`protected java.lang.String`	`printModel_protected()` Internal method that handles printing the model as a string.
`java.util.List<java.lang.String>`	`printModelDescriptionDetails(boolean htmlFormat)` Print details of the model.
`java.lang.String`	`printUsage()` Print out required format for options.
`void`	`run_protected(Dataset Data)` Run a model without checking if stuff is trained (use carefully)
`java.lang.Object`	`runCommand(java.util.List<java.lang.Object> Command)` Process some command described by a list of Objects.
`void`	`setGenericModel(BaseModel x)` Set the model template
`void`	`setModel(int index, BaseModel x)` Set a specific submodel.
`void`	`setNumberOfModels(int n)` Defines the number of models to be trained.
`void`	`setOptions(java.util.List Options)` Set any options for this object.
`void`	`setPartitioner(BaseDatasetSplitter S)` Set the partitioner.
`protected void`	`train_protected(Dataset TrainingData)` Train a model without evaluating performance

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
  - Model
```
protected java.util.ArrayList<BaseModel> Model
```
    List of of models used by this model
  - Partitioner
```
protected BaseDatasetSplitter Partitioner
```
    Class used to partition data into similar groups
  - GenericModel
```
protected BaseModel GenericModel
```
    Model used to if a model template for a certain split is not defined
- Constructor Detail
  - SplitModel
```
public SplitModel()
```
- Method Detail
  - clone
```
public SplitModel clone()
```
    Overrides:
    
    clone in class BaseModel
  - 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
    
    Parameters:
    
    Options - Array of options as Objects - can be null
    
    Throws:
    
    java.lang.Exception - if problem with inputs
  - printUsage
```
public java.lang.String printUsage()
```
    Description copied from interface: Options
    
    Print out required format for options. For consistency, should start with "Usage: ".
    
    Specified by:
    
    printUsage in interface Options
    
    Returns:
    
    Usage for this function
  - getModel
```
public BaseModel getModel(int index)
```
    Description copied from interface: MultiModel
    
    Get a specific submodel.
    
    Specified by:
    
    getModel in interface MultiModel
    
    Parameters:
    
    index - Model to retrieve
    
    Returns:
    
    Requested model or null if index >= NModels
  - setNumberOfModels
```
public void setNumberOfModels(int n)
```
    Description copied from interface: MultiModel
    
    Defines the number of models to be trained. If a generic model is set, it will automatically use it to defined any new models
    
    Specified by:
    
    setNumberOfModels in interface MultiModel
    
    Parameters:
    
    n - Number of models to use
  - NModels
```
public int NModels()
```
    Returns the number of model slots currently available
    
    Specified by:
    
    NModels in interface MultiModel
    
    Returns:
    
    number of model slots currently available
  - getGenericModel
```
public BaseModel getGenericModel()
```
    Description copied from interface: MultiModel
    
    Get the model template
    
    Specified by:
    
    getGenericModel in interface MultiModel
    
    Returns:
    
    Pointer to the generic model
  - setGenericModel
```
public void setGenericModel(BaseModel x)
```
    Set the model template
    
    Specified by:
    
    setGenericModel in interface MultiModel
    
    Parameters:
    
    x - Template model (will be cloned)
  - 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
    
    Parameters:
    
    index - Index of submodel to be set
    
    x - Model to be used (creates a clone)
  - setPartitioner
```
public void setPartitioner(BaseDatasetSplitter S)
```
    Set the partitioner.
    
    Parameters:
    
    S - Dataset splitter
  - checkModelCount
```
protected void checkModelCount(int n)
```
    Checks if enough models are defined. Throw error otherwise
    
    Parameters:
    
    n - Number of models required
  - train_protected
```
protected void train_protected(Dataset TrainingData)
```
    Description copied from class: BaseModel
    
    Train a model without evaluating performance
    
    Specified by:
    
    train_protected in class BaseModel
    
    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)
    
    Specified by:
    
    run_protected in class BaseModel
    
    Parameters:
    
    Data - Training data
  - printCommand
```
public java.lang.String printCommand(java.util.List<java.lang.String> Command)
                              throws java.lang.Exception
```
    Description copied from interface: Printable
    
    Handles more complicated printing commands.
    
    Specified by:
    
    printCommand in interface Printable
    
    Overrides:
    
    printCommand in class BaseModel
    
    Parameters:
    
    Command - Command specifying what to print
    
    Returns:
    
    String formatted as requested
    
    Throws:
    
    java.lang.Exception - If command not understood
  - printModel_protected
```
protected java.lang.String printModel_protected()
```
    Description copied from class: BaseModel
    
    Internal method that handles printing the model as a string. Should end with a "\n"
    
    Specified by:
    
    printModel_protected in class BaseModel
    
    Returns:
    
    String representation of model
  - printModelDescriptionDetails
```
public java.util.List<java.lang.String> printModelDescriptionDetails(boolean htmlFormat)
```
    Description copied from class: BaseModel
    
    Print details of the model. Used by BaseModel.printDescription(boolean).
    Implementation note: No not add indentation for details. That is handled by BaseModel.printDescription(boolean). You should also call the super operation to get the Normalizer and Attribute selector settings
    
    Overrides:
    
    printModelDescriptionDetails in class BaseModel
    
    Parameters:
    
    htmlFormat - Whether to use HTML format
    
    Returns:
    
    List describing model details. Each entry is a different line of the description (i.e., in place of newline characters).
  - runCommand
```
public java.lang.Object runCommand(java.util.List<java.lang.Object> Command)
                            throws java.lang.Exception
```
    Description copied from interface: Commandable
    
    Process some command described by a list of Objects.
    
    Specified by:
    
    runCommand in interface Commandable
    
    Overrides:
    
    runCommand in class BaseModel
    
    Parameters:
    
    Command - Command as a list of objects
    
    Returns:
    
    Any output (null if no output generated by command)
    
    Throws:
    
    java.lang.Exception - If something goes wrong
  - getCitations
```
public java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,Citation>> getCitations()
```
    Description copied from interface: Citable
    
    Return a list of citations for this object and any underlying objects.
    
    Specified by:
    
    getCitations in interface Citable
    
    Overrides:
    
    getCitations in class BaseModel
    
    Returns:
    
    List of pairs: [Reason for Citation], [Citation]

Class SplitModel

Field Summary

Fields inherited from class magpie.models.BaseModel

Constructor Summary

Method Summary

Methods inherited from class magpie.models.BaseModel

Methods inherited from class java.lang.Object

Field Detail

Model

Partitioner

GenericModel

Constructor Detail

SplitModel

Method Detail

clone

setOptions

printUsage

getModel

setNumberOfModels

NModels

getGenericModel

setGenericModel

setModel

setPartitioner

checkModelCount

train_protected

run_protected

printCommand

printModel_protected

printModelDescriptionDetails

runCommand

getCitations