water.genmodel

Interface IGeneratedModel

All Known Implementing Classes:

DeepwaterMojoModel, DrfMojoModel, GbmMojoModel, GenModel, GlmMojoModel, GlmMultinomialMojoModel, GlrmMojoModel, KMeansMojoModel, MojoModel, SharedTreeMojoModel, Word2VecMojoModel

public interface IGeneratedModel

A generic interface to access generated models.

Method Summary

Methods

Modifier and Type	Method and Description
int	getColIdx(java.lang.String name) Returns index of column with give name or -1 if column is not found.
java.lang.String[][]	getDomainValues() Returns domain values for all columns including response column.
java.lang.String[]	getDomainValues(int i) Returns domain values for i-th column.
java.lang.String[]	getDomainValues(java.lang.String name) Gets domain of given column.
java.lang.String[]	getNames() The names of columns used in the model.
int	getNumClasses(int i) Get number of classes in in given column.
int	getNumCols() Returns number of columns used as input for training (i.e., exclude response and offset columns).
int	getNumResponseClasses() Return a number of classes in response column.
int	getPredsSize() Returns the expected size of preds array which is passed to `predict(double[], float[])` function.
int	getResponseIdx() Returns an index of the response column inside getDomains().
java.lang.String	getResponseName() Deprecated.
java.lang.String	getUUID() Returns model's unique identifier.
boolean	isAutoEncoder()
boolean	isClassifier()
int	mapEnum(int colIdx, java.lang.String categoricalValue) Maps given column's categorical to integer used by this model.

Method Detail

getUUID

java.lang.String getUUID()

Returns model's unique identifier.

getNumCols

int getNumCols()

Returns number of columns used as input for training (i.e., exclude response and offset columns).

getNames

java.lang.String[] getNames()

The names of columns used in the model. It contains names of input columns and a name of response column.

getResponseName

@Deprecated
java.lang.String getResponseName()

Deprecated.

The name of the response column.

getResponseIdx

int getResponseIdx()

Returns an index of the response column inside getDomains().

getNumClasses

int getNumClasses(int i)

Get number of classes in in given column. Return number greater than zero if the column is categorical or -1 if the column is numeric.

getNumResponseClasses

int getNumResponseClasses()

Return a number of classes in response column.

Returns:

number of response classes

Throws:

java.lang.UnsupportedOperationException - if called on a non-classifier model.

isClassifier

boolean isClassifier()

Returns:

true if this model represents a classifier, else it is used for regression.

isAutoEncoder

boolean isAutoEncoder()

Returns:

true if this model represents an AutoEncoder.

getDomainValues

java.lang.String[] getDomainValues(java.lang.String name)

Gets domain of given column.

Parameters:

name - column name

Returns:

return domain for given column or null if column is numeric.

getDomainValues

java.lang.String[] getDomainValues(int i)

Returns domain values for i-th column.

Parameters:

i - index of column

Returns:

domain for given categorical column or null if columns contains numeric value

getDomainValues

java.lang.String[][] getDomainValues()

Returns domain values for all columns including response column.

getColIdx

int getColIdx(java.lang.String name)

Returns index of column with give name or -1 if column is not found.

mapEnum

int mapEnum(int colIdx,
          java.lang.String categoricalValue)

Maps given column's categorical to integer used by this model. Returns -1 if mapping is not found.

getPredsSize

int getPredsSize()

Returns the expected size of preds array which is passed to `predict(double[], float[])` function.

Returns:

expected size of preds array