hex.genmodel

Class MojoModel

java.lang.Object

hex.genmodel.GenModel

hex.genmodel.MojoModel

All Implemented Interfaces:

IGenModel, java.io.Serializable, IGeneratedModel

Direct Known Subclasses:

CoxPHMojoModel, DeeplearningMojoModel, ExtendedIsolationForestMojoModel, GamMojoModelBase, GlmMojoModel, GlmMultinomialMojoModel, GlmOrdinalMojoModel, GlrmMojoModel, IsotonicRegressionMojoModel, KLimeMojoModel, KMeansMojoModel, MojoPipeline, PCAMojoModel, RuleFitMojoModel, SharedTreeMojoModel, StackedEnsembleMojoModel, SvmMojoModel, TargetEncoderMojoModel, Word2VecMojoModel

public abstract class MojoModel
extends GenModel

Prediction model based on the persisted binary data.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_algoName
boolean	_balanceClasses
ModelCategory	_category
double	_defaultThreshold
java.lang.String	_h2oVersion
ModelAttributes	_modelAttributes
double[]	_modelClassDistrib
ModelDescriptor	_modelDescriptor
double	_mojo_version
int	_nclasses
int	_nfeatures
double[]	_priorClassDistrib
Table[]	_reproducibilityInformation
boolean	_supervised
java.lang.String	_uuid

Fields inherited from class hex.genmodel.GenModel

_domains, _names, _offsetColumn, _responseColumn, _treatmentColumn

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MojoModel(java.lang.String[] columns, java.lang.String[][] domains, java.lang.String responseColumn)
protected	MojoModel(java.lang.String[] columns, java.lang.String[][] domains, java.lang.String responseColumn, java.lang.String treatmentColumn)

Method Summary

Modifier and Type	Method and Description
ModelCategory	getModelCategory() Returns this model category.
java.lang.String	getUUID() Returns model's unique identifier.
boolean	isSupervised() Returns true for supervised models.
static MojoModel	load(MojoReaderBackend mojoReader) Advanced way of constructing Mojo models by supplying a custom mojoReader.
static MojoModel	load(java.lang.String file) Primary factory method for constructing MojoModel instances.
static MojoModel	load(java.lang.String file, boolean readMetadata) Primary factory method for constructing MojoModel instances.
int	nclasses() Returns number of output classes for classifiers, 1 for regression models, and 0 for unsupervised models.
int	nfeatures() Returns number of input features.

Methods inherited from class hex.genmodel.GenModel

bitSetContains, bitSetIsInRange, calibrateClassProbabilities, convertDouble2Float, correctProbabilities, createAuxKey, features, GBM_rescale, getCategoricalEncoding, getColIdx, getDomainValues, getDomainValues, getDomainValues, getHeader, getModelCategories, getNames, getNumClasses, getNumCols, getNumResponseClasses, getOffsetName, getOrigDomainValues, getOrigNames, getOrigNumCols, getOrigProjectionArray, getOutputDomains, getOutputNames, getPrediction, getPredictionBinomial, getPredictionMultinomial, getPredsSize, getPredsSize, getResponseIdx, getResponseName, GLM_identityInv, GLM_inverseInv, GLM_logInv, GLM_logitInv, GLM_ologitInv, GLM_tweedieInv, img2pixels, internal_threadSafeInstance, isAutoEncoder, isClassifier, KMeans_closest, KMeans_distance, KMeans_distance, KMeans_distances, Kmeans_preprocessData, Kmeans_preprocessData, KMeans_simplex, log_rescale, mapEnum, nCatFeatures, requiresOffset, score0, score0, setCats, setCats, setInput, setInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_algoName

public java.lang.String _algoName

_h2oVersion

public java.lang.String _h2oVersion

_category

public ModelCategory _category

_uuid

public java.lang.String _uuid

_supervised

public boolean _supervised

_nfeatures

public int _nfeatures

_nclasses

public int _nclasses

_balanceClasses

public boolean _balanceClasses

_defaultThreshold

public double _defaultThreshold

_priorClassDistrib

public double[] _priorClassDistrib

_modelClassDistrib

public double[] _modelClassDistrib

_mojo_version

public double _mojo_version

_modelDescriptor

public ModelDescriptor _modelDescriptor

_modelAttributes

public ModelAttributes _modelAttributes

_reproducibilityInformation

public Table[] _reproducibilityInformation

Constructor Detail

MojoModel

protected MojoModel(java.lang.String[] columns,
                    java.lang.String[][] domains,
                    java.lang.String responseColumn)

MojoModel

protected MojoModel(java.lang.String[] columns,
                    java.lang.String[][] domains,
                    java.lang.String responseColumn,
                    java.lang.String treatmentColumn)

Method Detail

load

public static MojoModel load(java.lang.String file)
                      throws java.io.IOException

Primary factory method for constructing MojoModel instances.

Parameters:

file - Name of the zip file (or folder) with the model's data. This should be the data retrieved via the `GET /3/Models/{model_id}/mojo` endpoint.

Returns:

New `MojoModel` object.

Throws:

java.io.IOException - if `file` does not exist, or cannot be read, or does not represent a valid model.

load

public static MojoModel load(java.lang.String file,
                             boolean readMetadata)
                      throws java.io.IOException

Primary factory method for constructing MojoModel instances.

Parameters:

file - Name of the zip file (or folder) with the model's data. This should be the data retrieved via the `GET /3/Models/{model_id}/mojo` endpoint.

readMetadata - read additional model metadata (metrics...) if enabled, otherwise skip metadata parsing

Returns:

New `MojoModel` object.

Throws:

java.io.IOException - if `file` does not exist, or cannot be read, or does not represent a valid model.

load

public static MojoModel load(MojoReaderBackend mojoReader)
                      throws java.io.IOException

Advanced way of constructing Mojo models by supplying a custom mojoReader.

Parameters:

mojoReader - a class that implements the MojoReaderBackend interface.

Returns:

New `MojoModel` object

Throws:

java.io.IOException - if the mojoReader does

isSupervised

public boolean isSupervised()

Description copied from class: GenModel

Returns true for supervised models.

Specified by:

isSupervised in interface IGenModel

Overrides:

isSupervised in class GenModel

Returns:

true if this class represents supervised model.

nfeatures

public int nfeatures()

Description copied from class: GenModel

Returns number of input features.

Specified by:

nfeatures in interface IGenModel

Overrides:

nfeatures in class GenModel

Returns:

number of input features used for training.

nclasses

public int nclasses()

Description copied from class: GenModel

Returns number of output classes for classifiers, 1 for regression models, and 0 for unsupervised models.

Specified by:

nclasses in interface IGenModel

Overrides:

nclasses in class GenModel

Returns:

returns number of output classes or 1 for regression models.

getModelCategory

public ModelCategory getModelCategory()

Description copied from class: GenModel

Returns this model category.

Specified by:

getModelCategory in interface IGenModel

Specified by:

getModelCategory in class GenModel

Returns:

model category

See Also:

ModelCategory

getUUID

public java.lang.String getUUID()

Description copied from interface: IGeneratedModel

Returns model's unique identifier.

Specified by:

getUUID in interface IGeneratedModel

Specified by:

getUUID in class GenModel