hex.genmodel

Class MojoModel

java.lang.Object

hex.genmodel.GenModel

hex.genmodel.MojoModel

All Implemented Interfaces:

IGenModel, java.io.Serializable, IGeneratedModel

Direct Known Subclasses:

TreeBasedModel

public abstract class MojoModel
extends GenModel

Prediction model based on the persisted binary data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MojoModel.MojoReader

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_balanceClasses
protected ModelCategory	_category
protected double	_defaultThreshold
protected double[]	_modelClassDistrib
protected int	_nclasses
protected int	_nfeatures
protected double[]	_priorClassDistrib
protected MojoModel.MojoReader	_reader
protected boolean	_supervised
protected java.lang.String	_uuid

Fields inherited from class hex.genmodel.GenModel

_domains, _names, _offsetColumn

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MojoModel(MojoModel.MojoReader cr, java.util.Map<java.lang.String,java.lang.Object> info, java.lang.String[] columns, java.lang.String[][] domains)

Method Summary

Methods

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(MojoModel.MojoReader 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.
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, correctProbabilities, GBM_rescale, getColIdx, getDomainValues, getDomainValues, getDomainValues, getHeader, getNames, getNumClasses, getNumCols, getNumResponseClasses, getPrediction, getPredsSize, getResponseIdx, getResponseName, GLM_identityInv, GLM_inverseInv, GLM_logInv, GLM_logitInv, GLM_tweedieInv, isAutoEncoder, isClassifier, KMeans_closest, KMeans_distance, KMeans_distance, KMeans_simplex, log_rescale, map, mapEnum, predict, predict, score0, score0, score0, score0, score0

Methods inherited from class java.lang.Object

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

Field Detail

_reader

protected transient MojoModel.MojoReader _reader

_category

protected ModelCategory _category

_uuid

protected java.lang.String _uuid

_supervised

protected boolean _supervised

_nfeatures

protected int _nfeatures

_nclasses

protected int _nclasses

_balanceClasses

protected boolean _balanceClasses

_defaultThreshold

protected double _defaultThreshold

_priorClassDistrib

protected double[] _priorClassDistrib

_modelClassDistrib

protected double[] _modelClassDistrib

Constructor Detail

MojoModel

protected MojoModel(MojoModel.MojoReader cr,
         java.util.Map<java.lang.String,java.lang.Object> info,
         java.lang.String[] columns,
         java.lang.String[][] domains)

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(MojoModel.MojoReader mojoReader)
                      throws java.io.IOException

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

Parameters:

mojoReader - a class that implements the MojoModel.MojoReader 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