hex.genmodel

Class ModelMojoReader<M extends MojoModel>

java.lang.Object

hex.genmodel.ModelMojoReader<M>

Direct Known Subclasses:

CoxPHMojoReader, DeeplearningMojoReader, ExtendedIsolationForestMojoReader, GamMojoReader, GlmMojoReader, GlrmMojoReader, IsotonicRegressionMojoReader, KMeansMojoReader, MultiModelMojoReader, PCAMojoReader, SharedTreeMojoReader, SvmMojoReader, TargetEncoderMojoReader, Word2VecMojoReader

public abstract class ModelMojoReader<M extends MojoModel>
extends java.lang.Object

Helper class to deserialize a model from MOJO format. This is a counterpart to `ModelMojoWriter`.

Field Summary

Fields

Modifier and Type	Field and Description
protected M	_model
protected MojoReaderBackend	_reader

Constructor Summary

Constructors

Constructor and Description
ModelMojoReader()

Method Summary

Modifier and Type	Method and Description
static LinkFunctionType	defaultLinkFunction(DistributionFamily family)
protected boolean	exists(java.lang.String name)
abstract java.lang.String	getModelName()
protected MojoReaderBackend	getMojoReaderBackend()
protected abstract M	makeModel(java.lang.String[] columns, java.lang.String[][] domains, java.lang.String responseColumn)
protected M	makeModel(java.lang.String[] columns, java.lang.String[][] domains, java.lang.String responseColumn, java.lang.String treatmentColumn)
abstract java.lang.String	mojoVersion() Maximal version of the mojo file current model reader supports.
protected byte[]	readblob(java.lang.String name) Retrieve binary data previously saved to the mojo file using `writeblob(key, blob)`.
static MojoModel	readFrom(MojoReaderBackend reader) De-serializes a MojoModel, creating an instance of MojoModel useful for scoring and model evaluation.
static MojoModel	readFrom(MojoReaderBackend reader, boolean readModelMetadata) De-serializes a MojoModel, creating an instance of MojoModel useful for scoring and model evaluation.
protected IsotonicCalibrator	readIsotonicCalibrator()
protected <T> T	readkv(java.lang.String key) Retrieve value from the model's kv store which was previously put there using `writekv(key, value)`.
protected <T> T	readkv(java.lang.String key, T defVal) Retrieves the value associated with a given key.
static LinkFunctionType	readLinkFunction(java.lang.String linkFunctionTypeName, DistributionFamily family)
protected abstract void	readModelData()
protected ModelAttributes	readModelSpecificAttributes()
protected double[][]	readRectangularDoubleArray(java.lang.String title) Reads an two dimensional array written by hex.ModelMojoWriter#writeRectangularDoubleArray method Dimensions of the array are read from the mojo.
protected double[][]	readRectangularDoubleArray(java.lang.String title, int firstSize, int secondSize) Reads an two dimensional array written by hex.ModelMojoWriter#writeRectangularDoubleArray method.
protected Table[]	readReproducibilityInformation()
protected java.lang.String[]	readStringArray(java.lang.String name, int size)
java.lang.String[]	readStringArrays(int aSize, java.lang.String title)
protected java.lang.Iterable<java.lang.String>	readtext(java.lang.String name) Retrieve text previously saved using `startWritingTextFile` + `writeln` as an array of lines.
protected java.lang.Iterable<java.lang.String>	readtext(java.lang.String name, boolean unescapeNewlines) Retrieve text previously saved using `startWritingTextFile` + `writeln` as an array of lines.

Methods inherited from class java.lang.Object

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

Field Detail

_model

protected M extends MojoModel _model

_reader

protected MojoReaderBackend _reader

Constructor Detail

ModelMojoReader

public ModelMojoReader()

Method Detail

readFrom

public static MojoModel readFrom(MojoReaderBackend reader)
                          throws java.io.IOException

De-serializes a MojoModel, creating an instance of MojoModel useful for scoring and model evaluation.

Parameters:

reader - An instance of MojoReaderBackend to read from existing MOJO. After the model is de-serialized, the MojoReaderBackend instance is automatically closed if it implements Closeable.

Returns:

De-serialized MojoModel

Throws:

java.io.IOException - Whenever there is an error reading the MojoModel's data.

readFrom

public static MojoModel readFrom(MojoReaderBackend reader,
                                 boolean readModelMetadata)
                          throws java.io.IOException

De-serializes a MojoModel, creating an instance of MojoModel useful for scoring and model evaluation.

Parameters:

reader - An instance of MojoReaderBackend to read from existing MOJO

readModelMetadata - If true, parses also model metadata (model performance metrics... ModelAttributes) Model metadata are not required for scoring, it is advised to leave this option disabled if you want to use MOJO for inference only.

Returns:

De-serialized MojoModel

Throws:

java.io.IOException - Whenever there is an error reading the MojoModel's data.

getModelName

public abstract java.lang.String getModelName()

readModelData

protected abstract void readModelData()
                               throws java.io.IOException

Throws:

java.io.IOException

makeModel

protected abstract M makeModel(java.lang.String[] columns,
                               java.lang.String[][] domains,
                               java.lang.String responseColumn)

makeModel

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

mojoVersion

public abstract java.lang.String mojoVersion()

Maximal version of the mojo file current model reader supports. Follows the major.minor format, where minor is a 2-digit number. For example "1.00", "2.05", "2.13". See README in mojoland repository for more details.

readkv

protected <T> T readkv(java.lang.String key)

Retrieve value from the model's kv store which was previously put there using `writekv(key, value)`. We will attempt to cast to your expected type, but this is obviously unsafe. Note that the value is deserialized from the underlying string representation using ParseUtils.tryParse(String, Object), which occasionally may get the answer wrong. If the `key` is missing in the local kv store, null will be returned. However when assigning to a primitive type this would result in an NPE, so beware.

readkv

protected <T> T readkv(java.lang.String key,
                       T defVal)

Retrieves the value associated with a given key. If value is not set of the key, a given default value is returned instead. Uses same parsing logic as readkv(String). If default value is not null it's type is used to assist the parser to determine the return type.

Type Parameters:

T - return type

Parameters:

key - name of the key

defVal - default value

Returns:

parsed value

readblob

protected byte[] readblob(java.lang.String name)
                   throws java.io.IOException

Retrieve binary data previously saved to the mojo file using `writeblob(key, blob)`.

Throws:

java.io.IOException

exists

protected boolean exists(java.lang.String name)

readtext

protected java.lang.Iterable<java.lang.String> readtext(java.lang.String name)
                                                 throws java.io.IOException

Retrieve text previously saved using `startWritingTextFile` + `writeln` as an array of lines. Each line is trimmed to remove the leading and trailing whitespace.

Throws:

java.io.IOException

readtext

protected java.lang.Iterable<java.lang.String> readtext(java.lang.String name,
                                                        boolean unescapeNewlines)
                                                 throws java.io.IOException

Retrieve text previously saved using `startWritingTextFile` + `writeln` as an array of lines. Each line is trimmed to remove the leading and trailing whitespace. Removes escaping of the new line characters in enabled.

Throws:

java.io.IOException

readStringArray

protected java.lang.String[] readStringArray(java.lang.String name,
                                             int size)
                                      throws java.io.IOException

Throws:

java.io.IOException

readIsotonicCalibrator

protected IsotonicCalibrator readIsotonicCalibrator()
                                             throws java.io.IOException

Throws:

java.io.IOException

readRectangularDoubleArray

protected double[][] readRectangularDoubleArray(java.lang.String title,
                                                int firstSize,
                                                int secondSize)
                                         throws java.io.IOException

Reads an two dimensional array written by hex.ModelMojoWriter#writeRectangularDoubleArray method. Dimensions of the result are explicitly given as parameters.

Parameters:

title - can't be null

firstSize -

secondSize -

Returns:

and double[][] array with dimensions firstSize and secondSize

Throws:

java.io.IOException

readRectangularDoubleArray

protected double[][] readRectangularDoubleArray(java.lang.String title)
                                         throws java.io.IOException

Reads an two dimensional array written by hex.ModelMojoWriter#writeRectangularDoubleArray method Dimensions of the array are read from the mojo.

Parameters:

title - can't be null

Throws:

java.io.IOException

readReproducibilityInformation

protected Table[] readReproducibilityInformation()

readModelSpecificAttributes

protected ModelAttributes readModelSpecificAttributes()

readLinkFunction

public static LinkFunctionType readLinkFunction(java.lang.String linkFunctionTypeName,
                                                DistributionFamily family)

defaultLinkFunction

public static LinkFunctionType defaultLinkFunction(DistributionFamily family)

getMojoReaderBackend

protected MojoReaderBackend getMojoReaderBackend()

readStringArrays

public java.lang.String[] readStringArrays(int aSize,
                                           java.lang.String title)
                                    throws java.io.IOException

Throws:

java.io.IOException