hex.deeplearning

Class DeepLearningModel

java.lang.Object

water.Iced

water.Keyed

water.Lockable<M>

hex.Model<M,P,O>

hex.SupervisedModel<DeepLearningModel,DeepLearningModel.DeepLearningParameters,DeepLearningModel.DeepLearningOutput>

hex.deeplearning.DeepLearningModel

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable

public class DeepLearningModel
extends hex.SupervisedModel<DeepLearningModel,DeepLearningModel.DeepLearningParameters,DeepLearningModel.DeepLearningOutput>

The Deep Learning model It contains a DeepLearningModelInfo with the most up-to-date model, a scoring history, as well as some helpers to indicate the progress

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeepLearningModel.DeepLearningModelInfo
static class	DeepLearningModel.DeepLearningOutput
static class	DeepLearningModel.DeepLearningParameters
static class	DeepLearningModel.Errors

Nested classes/interfaces inherited from class hex.Model

hex.Model.ModelCategory, hex.Model.Output<M extends hex.Model<M,P,O>,P extends hex.Model.Parameters<M,P,O>,O extends hex.Model.Output<M,P,O>>, hex.Model.Parameters<M extends hex.Model<M,P,O>,P extends hex.Model.Parameters<M,P,O>,O extends hex.Model.Output<M,P,O>>

Field Summary

Fields

Modifier and Type	Field and Description
long	_timeLastScoreEnter
water.Key	actual_best_model_key
long	actual_train_samples_per_iteration
double	epoch_counter
double	time_for_communication_us
long	training_rows
long	validation_rows

Fields inherited from class hex.SupervisedModel

_modelClassDist, _priorClassDist

Fields inherited from class hex.Model

_output, _parms, _warnings, training_duration_in_ms, training_start_time

Fields inherited from class water.Lockable

_lockers

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
DeepLearningModel(DeepLearningModel cp, water.Key destKey, water.Key jobKey, FrameTask.DataInfo dataInfo) Constructor to restart from a checkpointed model
DeepLearningModel(water.Key destKey, water.Key jobKey, water.Key dataKey, FrameTask.DataInfo dinfo, DeepLearningModel.DeepLearningParameters params, float[] priorDist)

Method Summary

Methods

Modifier and Type	Method and Description
hex.ConfusionMatrix2	cm() for grid search error reporting
int	compareTo(DeepLearningModel o)
void	delete_best_model()
void	delete_xval_models()
float	error()
DeepLearningModel.DeepLearningParameters	get_params()
protected double	missingColumnsType()
DeepLearningModel.DeepLearningModelInfo	model_info()
double	mse()
static FrameTask.DataInfo	prepareDataInfo(DeepLearningModel.DeepLearningParameters parms) Helper to create a DataInfo object from the source and response
water.api.ModelSchema	schema()
water.fvec.Frame	score(water.fvec.Frame frame) This is an overridden version of Model.score().
float[]	score0(double[] data, float[] preds) Predict from raw double values representing the data
water.fvec.Frame	scoreAutoEncoder(water.fvec.Frame frame) Score auto-encoded reconstruction (on-the-fly, without allocating the reconstruction as done in Frame score(Frame fr))
DeepLearningModel.Errors[]	scoring_history()
java.lang.String	toString()
java.lang.String	toStringAll()
hex.VarImp	varimp()

Methods inherited from class hex.SupervisedModel

calcError, isSupervised, score0, setModelClassDistribution

Methods inherited from class hex.Model

adapt, adapt, adapt, addWarning, checksum, computeModelMetrics, getDomainMapping, getDomainMapping, remove_impl, score, score, score, score, score, start_training, start_training, stop_training

Methods inherited from class water.Lockable

delete_and_lock, delete, delete, delete, read_lock, read_lock, unlock_all, unlock, update, write_lock

Methods inherited from class water.Keyed

remove, remove, remove, remove

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, write_impl, write, writeExternal, writeHTML_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

actual_train_samples_per_iteration

public long actual_train_samples_per_iteration

time_for_communication_us

public double time_for_communication_us

epoch_counter

public double epoch_counter

training_rows

public long training_rows

validation_rows

public long validation_rows

actual_best_model_key

public water.Key actual_best_model_key

_timeLastScoreEnter

public long _timeLastScoreEnter

Constructor Detail

DeepLearningModel

public DeepLearningModel(DeepLearningModel cp,
                 water.Key destKey,
                 water.Key jobKey,
                 FrameTask.DataInfo dataInfo)

Constructor to restart from a checkpointed model

Parameters:

cp - Checkpoint to restart from

destKey - New destination key for the model

jobKey - New job key (job which updates the model)

DeepLearningModel

public DeepLearningModel(water.Key destKey,
                 water.Key jobKey,
                 water.Key dataKey,
                 FrameTask.DataInfo dinfo,
                 DeepLearningModel.DeepLearningParameters params,
                 float[] priorDist)

Method Detail

schema

public water.api.ModelSchema schema()

Specified by:

schema in class hex.Model<DeepLearningModel,DeepLearningModel.DeepLearningParameters,DeepLearningModel.DeepLearningOutput>

model_info

public final DeepLearningModel.DeepLearningModelInfo model_info()

scoring_history

public DeepLearningModel.Errors[] scoring_history()

get_params

public final DeepLearningModel.DeepLearningParameters get_params()

missingColumnsType

protected double missingColumnsType()

Overrides:

missingColumnsType in class hex.Model<DeepLearningModel,DeepLearningModel.DeepLearningParameters,DeepLearningModel.DeepLearningOutput>

error

public float error()

compareTo

public int compareTo(DeepLearningModel o)

cm

public hex.ConfusionMatrix2 cm()

for grid search error reporting

mse

public double mse()

varimp

public hex.VarImp varimp()

prepareDataInfo

public static FrameTask.DataInfo prepareDataInfo(DeepLearningModel.DeepLearningParameters parms)

Helper to create a DataInfo object from the source and response

Returns:

DataInfo object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringAll

public java.lang.String toStringAll()

score

public water.fvec.Frame score(water.fvec.Frame frame)

This is an overridden version of Model.score(). Make either a prediction or a reconstruction.

Overrides:

score in class hex.Model<DeepLearningModel,DeepLearningModel.DeepLearningParameters,DeepLearningModel.DeepLearningOutput>

Parameters:

frame - Test dataset

Returns:

A frame containing the prediction or reconstruction

score0

public float[] score0(double[] data,
             float[] preds)

Predict from raw double values representing the data

Specified by:

score0 in class hex.Model<DeepLearningModel,DeepLearningModel.DeepLearningParameters,DeepLearningModel.DeepLearningOutput>

Parameters:

data - raw array containing categorical values (horizontalized to 1,0,0,1,0,0 etc.) and numerical values (0.35,1.24,5.3234,etc), both can contain NaNs

preds - predicted label and per-class probabilities (for classification), predicted target (regression), can contain NaNs

Returns:

preds, can contain NaNs

scoreAutoEncoder

public water.fvec.Frame scoreAutoEncoder(water.fvec.Frame frame)

Score auto-encoded reconstruction (on-the-fly, without allocating the reconstruction as done in Frame score(Frame fr))

Parameters:

frame - Original data (can contain response, will be ignored)

Returns:

Frame containing one Vec with reconstruction error (MSE) of each reconstructed row, caller is responsible for deletion

delete_best_model

public void delete_best_model()

delete_xval_models

public void delete_xval_models()