BaseDatasetSplitter (magpie API)

java.lang.Object
- magpie.data.utilities.splitters.BaseDatasetSplitter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Commandable, Options, Printable

Direct Known Subclasses:

AllMetalsSplitter, AttributeIntervalSplitter, ClustererSplitter, FilterSplitter, MeasuredClassSplitter, NonZeroClassificationSplitter, ObjectiveFunctionSplitter, PredictedClassIntervalSplitter, SingleElementGroupSplitter
```
public abstract class BaseDatasetSplitter
extends java.lang.Object
implements java.io.Serializable, Options, Commandable, java.lang.Cloneable, Printable
```
This class provides an interface to Dataset splitting operations. Any implementation must fill the following operations:
- label(magpie.data.Dataset) - Returns a list of integers that specify which subset each entry belongs to
- Options.setOptions(java.util.List<java.lang.Object>) - Define settings for this splitter
- train(magpie.data.Dataset) - Train a Dataset splitter, if needed
Implemented Commands
<output> = get <partition number> $<dataset> - Get a certain partition from a dataset
partition number: Index (starting at 0) of desired partition
dataset: Dataset to be split
save $<data> <filename> [<format>] - Split a dataset, then print it out to files
data: Datasetto be printed
filename: Names of files. Output will be this + split number for each split.
format: Optional: Format in which to write data (default=serialized)
train $<data> - Train splitter
data: Dataset used to train splitter
Print Commands details - Description of this splitter names - Names of the splits
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BaseDatasetSplitter()

Constructors
Constructor and Description
`BaseDatasetSplitter()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`about()` Prints a simple status message about this object
`BaseDatasetSplitter`	`clone()`
`abstract java.util.List<java.lang.String>`	`getSplitNames()` Get the names of the splits this splitter creates
`protected abstract java.util.List<java.lang.String>`	`getSplitterDetails(boolean htmlFormat)` Get details of splitter.
`abstract int[]`	`label(Dataset D)` Given a dataset, determine which subset each entry should belong to.
`java.lang.String`	`printCommand(java.util.List<java.lang.String> Command)` Handles more complicated printing commands.
`java.lang.String`	`printDescription(boolean htmlFormat)` Print full name of object, and a simple description of the options.
`java.lang.Object`	`runCommand(java.util.List<java.lang.Object> Command)` Process some command described by a list of Objects.
`java.util.List<Dataset>`	`split(Dataset data)` Splits a dataset into several partitions.
`java.util.List<Dataset>`	`split(Dataset data, boolean toRetain)` Split a dataset into several partitions.
`abstract void`	`train(Dataset TrainingSet)` Train a dataset splitter, if necessary

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface magpie.utility.interfaces.Options
printUsage, setOptions

- Constructor Detail
  - BaseDatasetSplitter
```
public BaseDatasetSplitter()
```
- Method Detail
  - clone
```
public BaseDatasetSplitter clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - label
```
public abstract int[] label(Dataset D)
```
    Given a dataset, determine which subset each entry should belong to. Please ensure that D remains unaltered (clone if you must)
    
    Parameters:
    
    D - Dataset to be labeled
    
    Returns:
    
    A list of nonnegative integers marking which subset to split each entry into
  - split
```
public java.util.List<Dataset> split(Dataset data)
```
    Splits a dataset into several partitions.
    
    Parameters:
    
    data - Dataset to be split. Returns empty from this operation
    
    Returns:
    
    List of classes where each entry is a different partition
  - split
```
public java.util.List<Dataset> split(Dataset data,
                                     boolean toRetain)
```
    Split a dataset into several partitions.
    
    Parameters:
    
    data - Dataset to be split
    
    toRetain - Whether to keep entries in the original dataset
    
    Returns:
    
    List of classes where each entry is a different partition
  - train
```
public abstract void train(Dataset TrainingSet)
```
    Train a dataset splitter, if necessary
    
    Parameters:
    
    TrainingSet - Dataset to use for training
  - 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
    
    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
  - about
```
public java.lang.String about()
```
    Description copied from interface: Printable
    
    Prints a simple status message about this object
    
    Specified by:
    
    about in interface Printable
    
    Returns:
    
    Short status message
  - printDescription
```
public java.lang.String printDescription(boolean htmlFormat)
```
    Description copied from interface: Printable
    
    Print full name of object, and a simple description of the options. This description should print enough information to reproduce how this object was created, but not necessarily enough to run it (e.g., coefficients for the model).
    Example: For a model training a separate WekaRegression for intermetallics
    magpie.models.regression.SplitRegression
    Splitter: AllMetalsSplitter
    All Metals: magpie.models.regression.WekaRegression trees.REPTree
    Contains Nonmetal: magpie.regression.LASSORegreession -maxterms 2
    
    Specified by:
    
    printDescription in interface Printable
    
    Parameters:
    
    htmlFormat - Whether format for output to an HTML page (e.g., <div> to create indentation) or for printing to screen.
    
    Returns:
    
    String describing the model
    
    See Also:
    
    #printModel()
  - getSplitterDetails
```
protected abstract java.util.List<java.lang.String> getSplitterDetails(boolean htmlFormat)
```
    Get details of splitter. Returns a list of options that can be set by the user. Used with printDescription(boolean).
    
    Parameters:
    
    htmlFormat - Whether to format results with HTML
    
    Returns:
    
    List of options describing the model
  - 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
    
    Parameters:
    
    Command - Command specifying what to print
    
    Returns:
    
    String formatted as requested
    
    Throws:
    
    java.lang.Exception - If command not understood
  - getSplitNames
```
public abstract java.util.List<java.lang.String> getSplitNames()
```
    Get the names of the splits this splitter creates
    
    Returns:
    
    Names of each group

Class BaseDatasetSplitter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface magpie.utility.interfaces.Options

Constructor Detail

BaseDatasetSplitter

Method Detail

clone

label

split

split

train

runCommand

about

printDescription

getSplitterDetails

printCommand

getSplitNames