ai.h2o.automl

Class ModelingStep<M extends hex.Model>

java.lang.Object

water.Iced<ModelingStep>

ai.h2o.automl.ModelingStep<M>

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable<ModelingStep>

Direct Known Subclasses:

ModelingStep.GridStep, ModelingStep.ModelStep, ModelingStep.SelectionStep

public abstract class ModelingStep<M extends hex.Model>
extends water.Iced<ModelingStep>

Parent class defining common properties and common logic for actual AutoML training steps.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelingStep.GridStep<M extends hex.Model> Convenient base class for steps defining a (random) grid search.
static class	ModelingStep.ModelStep<M extends hex.Model> Convenient base class for single/default model steps.
protected static class	ModelingStep.SeedPolicy
static class	ModelingStep.SelectionStep<M extends hex.Model>

Field Summary

Fields

Modifier and Type	Field and Description
protected IAlgo	_algo
protected java.lang.String	_description
protected java.lang.String	_id
protected AutoML.Constraint[]	_ignoredConstraints
protected int	_weight

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelingStep(IAlgo algo, java.lang.String id, int weight, AutoML autoML)

Method Summary

Modifier and Type	Method and Description
protected AutoML	aml()
protected void	applyPreprocessing(hex.Model.Parameters params)
protected boolean	canRun()
protected abstract WorkAllocations.Work	getAllocatedWork()
protected PreprocessingConfig	getPreprocessingConfig()
protected hex.Model[]	getTrainedModels()
protected water.Key<hex.Model>[]	getTrainedModelsKeys()
protected WorkAllocations	getWorkAllocations()
protected void	initTimeConstraints(hex.Model.Parameters parms, double upperLimit)
protected boolean	isCVEnabled()
protected abstract water.Key	makeKey(java.lang.String name, boolean withCounter)
protected abstract WorkAllocations.Work	makeWork()
protected void	onDone(water.Job job)
protected void	setClassBalancingParams(hex.Model.Parameters params)
protected void	setCommonModelBuilderParams(hex.Model.Parameters params) Assign common parameters to the model params before building the model or set of models.
protected void	setCrossValidationParams(hex.Model.Parameters params)
protected void	setCustomParams(hex.Model.Parameters params)
protected void	setSeed(hex.Model.Parameters parms, hex.Model.Parameters defaults, ModelingStep.SeedPolicy seedPolicy)
protected void	setStoppingCriteria(hex.Model.Parameters parms, hex.Model.Parameters defaults) Configures early-stopping for the model or set of models to be built.
protected void	setWeightingParams(hex.Model.Parameters params)
protected abstract water.Job	startJob()
protected <M extends hex.Model,MP extends hex.Model.Parameters> water.Job<M>	startModel(water.Key<M> resultKey, MP params)
protected <MP extends hex.Model.Parameters> water.Job<hex.grid.Grid>	startSearch(water.Key<hex.grid.Grid> resultKey, MP baseParams, java.util.Map<java.lang.String,java.lang.Object[]> hyperParams, hex.grid.HyperSpaceSearchCriteria searchCriteria)

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

_algo

protected final IAlgo _algo

_id

protected final java.lang.String _id

_weight

protected int _weight

_ignoredConstraints

protected AutoML.Constraint[] _ignoredConstraints

_description

protected java.lang.String _description

Constructor Detail

ModelingStep

protected ModelingStep(IAlgo algo,
                       java.lang.String id,
                       int weight,
                       AutoML autoML)

Method Detail

startSearch

protected <MP extends hex.Model.Parameters> water.Job<hex.grid.Grid> startSearch(water.Key<hex.grid.Grid> resultKey,
                                                                                 MP baseParams,
                                                                                 java.util.Map<java.lang.String,java.lang.Object[]> hyperParams,
                                                                                 hex.grid.HyperSpaceSearchCriteria searchCriteria)

startModel

protected <M extends hex.Model,MP extends hex.Model.Parameters> water.Job<M> startModel(water.Key<M> resultKey,
                                                                                        MP params)

getAllocatedWork

protected abstract WorkAllocations.Work getAllocatedWork()

makeKey

protected abstract water.Key makeKey(java.lang.String name,
                                     boolean withCounter)

makeWork

protected abstract WorkAllocations.Work makeWork()

startJob

protected abstract water.Job startJob()

onDone

protected void onDone(water.Job job)

aml

protected AutoML aml()

canRun

protected boolean canRun()

getWorkAllocations

protected WorkAllocations getWorkAllocations()

getTrainedModels

protected hex.Model[] getTrainedModels()

getTrainedModelsKeys

protected water.Key<hex.Model>[] getTrainedModelsKeys()

isCVEnabled

protected boolean isCVEnabled()

setCommonModelBuilderParams

protected void setCommonModelBuilderParams(hex.Model.Parameters params)

Assign common parameters to the model params before building the model or set of models. This includes:

• data-related parameters: frame/columns parameters, class distribution.
• cross-validation parameters/
• memory-optimization: if certain objects build during training should be kept after training or not/
• model management: checkpoints.

Parameters:

params - the model parameters to which the common parameters will be added.

setCrossValidationParams

protected void setCrossValidationParams(hex.Model.Parameters params)

setWeightingParams

protected void setWeightingParams(hex.Model.Parameters params)

setClassBalancingParams

protected void setClassBalancingParams(hex.Model.Parameters params)

setCustomParams

protected void setCustomParams(hex.Model.Parameters params)

applyPreprocessing

protected void applyPreprocessing(hex.Model.Parameters params)

getPreprocessingConfig

protected PreprocessingConfig getPreprocessingConfig()

setStoppingCriteria

protected void setStoppingCriteria(hex.Model.Parameters parms,
                                   hex.Model.Parameters defaults)

Configures early-stopping for the model or set of models to be built.

Parameters:

parms - the model parameters to which the stopping criteria will be added.

defaults - the default parameters for the corresponding ModelBuilder.

setSeed

protected void setSeed(hex.Model.Parameters parms,
                       hex.Model.Parameters defaults,
                       ModelingStep.SeedPolicy seedPolicy)

Parameters:

parms - the model parameters to which the stopping criteria will be added.

defaults - the default parameters for the corresponding ModelBuilder.

seedPolicy - the policy defining how the seed will be assigned to the model parameters.

initTimeConstraints

protected void initTimeConstraints(hex.Model.Parameters parms,
                                   double upperLimit)