hex.genmodel.descriptor

Class ModelDescriptorBuilder.MojoModelDescriptor

java.lang.Object

hex.genmodel.descriptor.ModelDescriptorBuilder.MojoModelDescriptor

All Implemented Interfaces:

ModelDescriptor, java.io.Serializable

Enclosing class:

ModelDescriptorBuilder

public static class ModelDescriptorBuilder.MojoModelDescriptor
extends java.lang.Object
implements ModelDescriptor, java.io.Serializable

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.lang.String	algoFullName()
java.lang.String	algoName()
boolean	balanceClasses()
java.lang.String[]	columnNames()
double	defaultThreshold() Default threshold for assigning class labels to the target class.
java.lang.String[]	features()
java.lang.String	foldColumn()
ModelCategory	getModelCategory() Model's category.
java.lang.String[][]	getOrigDomains()
java.lang.String[]	getOrigNames()
boolean	isSupervised()
double[]	modelClassDist()
int	nclasses()
int	nfeatures()
java.lang.String	offsetColumn()
double[]	priorClassDist()
java.lang.String	projectVersion() E.g.
java.lang.String[][]	scoringDomains() Domains of categorical features.
java.lang.String	timestamp()
java.lang.String	treatmentColumn()
java.lang.String	uuid()
java.lang.String	weightsColumn()

Methods inherited from class java.lang.Object

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

Method Detail

scoringDomains

public java.lang.String[][] scoringDomains()

Description copied from interface: ModelDescriptor

Domains of categorical features. For each feature, there is a record. If the feature is not categorical, the value is null.

Specified by:

scoringDomains in interface ModelDescriptor

Returns:

An array of String representing the complete domain of each feature. Null if the feature is not categorical.

projectVersion

public java.lang.String projectVersion()

Description copied from interface: ModelDescriptor

E.g. "3.24.0.1"

Specified by:

projectVersion in interface ModelDescriptor

Returns:

A String representing version of H2O Open Source Machine Learning platform project.

algoName

public java.lang.String algoName()

Specified by:

algoName in interface ModelDescriptor

Returns:

A string with human-readable shortcut of the algorithm enveloped by this MOJO. Never null.

algoFullName

public java.lang.String algoFullName()

Specified by:

algoFullName in interface ModelDescriptor

Returns:

A string with human-readable, full textual representation of the algorithm. Never null.

offsetColumn

public java.lang.String offsetColumn()

Specified by:

offsetColumn in interface ModelDescriptor

Returns:

A String with the name of the offset column used. Null if there was no offset column used during training.

weightsColumn

public java.lang.String weightsColumn()

Specified by:

weightsColumn in interface ModelDescriptor

Returns:

A String with the name of the weights column used. Null if there were no weights applied to the dataset.

foldColumn

public java.lang.String foldColumn()

Specified by:

foldColumn in interface ModelDescriptor

Returns:

A String with the name of the fold column used. Null of there was no folding by using a fold column as a key done.

treatmentColumn

public java.lang.String treatmentColumn()

Specified by:

treatmentColumn in interface ModelDescriptor

Returns:

A String with the name of the treatment column used. Null of there was no treatment used during training.

getModelCategory

public ModelCategory getModelCategory()

Description copied from interface: ModelDescriptor

Model's category.

Specified by:

getModelCategory in interface ModelDescriptor

Returns:

One of ModelCategory values. Never null.

isSupervised

public boolean isSupervised()

Specified by:

isSupervised in interface ModelDescriptor

Returns:

True for supervised learning models, false for unsupervised.

nfeatures

public int nfeatures()

Specified by:

nfeatures in interface ModelDescriptor

Returns:

An integer representing a total count of features used for training of the model.

features

public java.lang.String[] features()

Specified by:

features in interface ModelDescriptor

Returns:

An array String representing the names of the features used for model training.

nclasses

public int nclasses()

Specified by:

nclasses in interface ModelDescriptor

Returns:

Domain cardinality of the response column, Only meaningful if the model has a categorical response and the model is supervised.

columnNames

public java.lang.String[] columnNames()

Specified by:

columnNames in interface ModelDescriptor

Returns:

An array of String representing the column names in the model. The very last one is the response column name, if the model has a response column.

balanceClasses

public boolean balanceClasses()

Specified by:

balanceClasses in interface ModelDescriptor

defaultThreshold

public double defaultThreshold()

Description copied from interface: ModelDescriptor

Default threshold for assigning class labels to the target class. Applicable to binomial models only.

Specified by:

defaultThreshold in interface ModelDescriptor

Returns:

A double primitive type with the default threshold value

priorClassDist

public double[] priorClassDist()

Specified by:

priorClassDist in interface ModelDescriptor

modelClassDist

public double[] modelClassDist()

Specified by:

modelClassDist in interface ModelDescriptor

uuid

public java.lang.String uuid()

Specified by:

uuid in interface ModelDescriptor

timestamp

public java.lang.String timestamp()

Specified by:

timestamp in interface ModelDescriptor

getOrigNames

public java.lang.String[] getOrigNames()

Specified by:

getOrigNames in interface ModelDescriptor

getOrigDomains

public java.lang.String[][] getOrigDomains()

Specified by:

getOrigDomains in interface ModelDescriptor