hex.genmodel

Class ModelMojoReader<M extends MojoModel>

java.lang.Object

hex.genmodel.ModelMojoReader<M>

Direct Known Subclasses:

DeeplearningMojoReader, DeepwaterMojoReader, GlmMojoReader, GlrmMojoReader, KMeansMojoReader, MultiModelMojoReader, SharedTreeMojoReader, SvmMojoReader, 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
protected boolean	exists(java.lang.String name)
abstract java.lang.String	getModelName()
protected abstract M	makeModel(java.lang.String[] columns, java.lang.String[][] domains, java.lang.String responseColumn)
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)
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.
protected abstract void	readModelData()
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

Throws:

java.io.IOException

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)

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