water.genmodel

Interface IGeneratedModel

All Known Implementing Classes:

GeneratedModel

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
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 column).
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.
java.lang.String	getResponseName() The name of the response column.
boolean	isClassifier() Return true if this model represents a classifier, else it is used for regression.
int	mapEnum(int colIdx, java.lang.String enumValue) Maps given column's enum to integer used by this model.
float[]	predict(double[] data, float[] preds) Predict the given row and return prediction.
float[]	predict(double[] data, float[] preds, int maxIters) Predict the given row and return prediction using given number of iterations (e.g., number of trees from forest).

Method Detail

getNumCols

int getNumCols()

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

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

java.lang.String getResponseName()

The name of the response column.

getResponseIdx

int getResponseIdx()

Returns an index of the response column.

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.

isClassifier

boolean isClassifier()

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

predict

float[] predict(double[] data,
              float[] preds)

Predict the given row and return prediction.

Parameters:

data - row holding the data. Ordering should follow ordering of columns returned by getNames()

preds - allocated array to hold a prediction

Returns:

returned preds parameter filled by prediction

predict

float[] predict(double[] data,
              float[] preds,
              int maxIters)

Predict the given row and return prediction using given number of iterations (e.g., number of trees from forest).

Parameters:

data - row holding the data. Ordering should follow ordering of columns returned by getNames()

preds - allocated array to hold a prediction

maxIters - maximum number of iterations to use during predicting process

Returns:

returned preds parameter filled by prediction

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 enum column or null if columns contains numeric value

getDomainValues

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

Returns domain values for all columns

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 enumValue)

Maps given column's enum 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