IGeneratedModel (h2o-genmodel 3.46.0 API)

All Known Implementing Classes:

CoxPHMojoModel, DeeplearningMojoModel, DrfMojoModel, ExtendedIsolationForestMojoModel, GamMojoModel, GamMojoModelBase, GamMojoMultinomialModel, GbmMojoModel, GenModel, GlmMojoModel, GlmMojoModelBase, GlmMultinomialMojoModel, GlmOrdinalMojoModel, GlrmMojoModel, IsolationForestMojoModel, IsotonicRegressionMojoModel, KLimeMojoModel, KMeansMojoModel, MojoModel, MojoPipeline, PCAMojoModel, RuleFitMojoModel, SharedTreeMojoModel, SharedTreeMojoModelWithContributions, StackedEnsembleMojoModel, SvmMojoModel, TargetEncoderMojoModel, UpliftDrfMojoModel, Word2VecMojoModel
```
public interface IGeneratedModel
```
A generic interface to access generated models.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CategoricalEncoding`	`getCategoricalEncoding()`
`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.
`java.lang.String`	`getOffsetName()` The name of the offset column.
`java.lang.String[][]`	`getOrigDomainValues()` Returns original domain values for all columns including response column.
`java.lang.String[]`	`getOrigNames()` The original names of columns used in the model.
`double[]`	`getOrigProjectionArray()` Returns original Eigen encoder projections array for all columns.
`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.
  - getOrigNames
```
java.lang.String[] getOrigNames()
```
    The original 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.
  - getOffsetName
```
java.lang.String getOffsetName()
```
    The name of the offset 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.
  - getCategoricalEncoding
```
CategoricalEncoding getCategoricalEncoding()
```
  - 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.
  - getOrigDomainValues
```
java.lang.String[][] getOrigDomainValues()
```
    Returns original domain values for all columns including response column.
  - getOrigProjectionArray
```
double[] getOrigProjectionArray()
```
    Returns original Eigen encoder projections array 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 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

Interface IGeneratedModel

Method Summary

Method Detail

getUUID

getNumCols

getNames

getOrigNames

getResponseName

getOffsetName

getResponseIdx

getNumClasses

getNumResponseClasses

getCategoricalEncoding

isClassifier

isAutoEncoder

getDomainValues

getDomainValues

getDomainValues

getOrigDomainValues

getOrigProjectionArray

getColIdx

mapEnum

getPredsSize