ai.h2o.automl

Class AutoML

java.lang.Object

water.Iced<T>

water.Keyed<T>

water.Lockable<AutoML>

ai.h2o.automl.AutoML

All Implemented Interfaces:

H2ORunnable, TimedH2ORunnable, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable<AutoML>

public final class AutoML
extends water.Lockable<AutoML>
implements TimedH2ORunnable

Initial draft of AutoML AutoML is a node-local driver class that is responsible for managing concurrent strategies of execution in an effort to discover an optimal supervised model for some given (dataset, response, loss) combo.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoML.algo
static class	AutoML.AutoMLKeyV3

Field Summary

Fields inherited from class water.Lockable

_lockers

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
AutoML()
AutoML(water.Key<AutoML> key, java.util.Date startTime, AutoMLBuildSpec buildSpec)

Method Summary

Methods

Modifier and Type	Method and Description
void	addModel(water.Key<hex.Model> newModel)
void	addModel(hex.Model newModel)
void	addModels(water.Key<hex.Model>[] newModels)
water.Job<hex.grid.Grid>	defaultSearchDL1()
water.Job<hex.grid.Grid>	defaultSearchDL2()
water.Job<hex.grid.Grid>	defaultSearchDL3()
water.Job<hex.grid.Grid>	defaultSearchGBM(water.Key<hex.grid.Grid> gridKey)
water.Job<hex.grid.Grid>	defaultSearchGLM()
void	delete() Delete the AutoML-related objects, but leave the grids and models that it built.
void	deleteWithChildren() Same as delete() but also deletes all Objects made from this instance.
void	get() Holds until AutoML's job is completed, if a job exists.
AutoMLBuildSpec	getBuildSpec()
water.fvec.Vec	getFoldColumn()
FrameMetadata	getFrameMetadata()
water.fvec.Frame	getLeaderboardFrame()
water.fvec.Vec	getResponseColumn()
long	getStopTimeMs()
water.fvec.Frame	getTrainingFrame()
water.fvec.Frame	getValidationFrame()
water.fvec.Vec	getWeightsColumn()
water.Job<hex.grid.Grid>	hyperparameterSearch(water.Key<hex.grid.Grid> gridKey, java.lang.String algoName, hex.Model.Parameters baseParms, java.util.Map<java.lang.String,java.lang.Object[]> searchParms) Do a random hyperparameter search.
water.Job<hex.grid.Grid>	hyperparameterSearch(java.lang.String algoName, hex.Model.Parameters baseParms, java.util.Map<java.lang.String,java.lang.Object[]> searchParms) Do a random hyperparameter search.
water.Job	job()
boolean	keepRunning()
hex.Model	leader()
Leaderboard	leaderboard()
void	learn()
static AutoML	makeAutoML(water.Key<AutoML> key, java.util.Date startTime, AutoMLBuildSpec buildSpec)
java.lang.Class<AutoML.AutoMLKeyV3>	makeSchema()
void	pollAndUpdateProgress(UserFeedbackEvent.Stage stage, java.lang.String name, long workContribution, water.Job parentJob, water.Job subJob, ai.h2o.automl.AutoML.JobType subJobType)
boolean	possiblyVerifyImmutability()
java.lang.String	projectName()
int	remainingModels()
void	run()
static void	startAutoML(AutoML aml) Takes in an AutoML instance and starts running it.
static AutoML	startAutoML(AutoMLBuildSpec buildSpec) Instantiate an AutoML object and start it running.
void	stop()
long	timeRemainingMs()
water.Job	trainModel(water.Key<hex.Model> key, java.lang.String algoURLName, hex.Model.Parameters parms) Helper for hex.ModelBuilder.
UserFeedback	userFeedback()

Methods inherited from class water.Lockable

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

Methods inherited from class water.Keyed

checksum_impl, checksum, readAll_impl, readAll, remove_impl, remove, remove, remove, remove, writeAll_impl, writeAll

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

Constructor Detail

AutoML

public AutoML()

AutoML

public AutoML(water.Key<AutoML> key,
      java.util.Date startTime,
      AutoMLBuildSpec buildSpec)

Method Detail

getBuildSpec

public AutoMLBuildSpec getBuildSpec()

getTrainingFrame

public water.fvec.Frame getTrainingFrame()

getValidationFrame

public water.fvec.Frame getValidationFrame()

getLeaderboardFrame

public water.fvec.Frame getLeaderboardFrame()

getResponseColumn

public water.fvec.Vec getResponseColumn()

getFoldColumn

public water.fvec.Vec getFoldColumn()

getWeightsColumn

public water.fvec.Vec getWeightsColumn()

getFrameMetadata

public FrameMetadata getFrameMetadata()

makeAutoML

public static AutoML makeAutoML(water.Key<AutoML> key,
                java.util.Date startTime,
                AutoMLBuildSpec buildSpec)

run

public void run()

Specified by:

run in interface H2ORunnable

stop

public void stop()

Specified by:

stop in interface H2ORunnable

getStopTimeMs

public long getStopTimeMs()

timeRemainingMs

public long timeRemainingMs()

Specified by:

timeRemainingMs in interface TimedH2ORunnable

remainingModels

public int remainingModels()

keepRunning

public boolean keepRunning()

Specified by:

keepRunning in interface TimedH2ORunnable

pollAndUpdateProgress

public void pollAndUpdateProgress(UserFeedbackEvent.Stage stage,
                         java.lang.String name,
                         long workContribution,
                         water.Job parentJob,
                         water.Job subJob,
                         ai.h2o.automl.AutoML.JobType subJobType)

trainModel

public water.Job trainModel(water.Key<hex.Model> key,
                   java.lang.String algoURLName,
                   hex.Model.Parameters parms)

Helper for hex.ModelBuilder.

Returns:

hyperparameterSearch

public water.Job<hex.grid.Grid> hyperparameterSearch(java.lang.String algoName,
                                            hex.Model.Parameters baseParms,
                                            java.util.Map<java.lang.String,java.lang.Object[]> searchParms)

Do a random hyperparameter search. Caller must eventually do a get() on the returned Job to ensure that it's complete.

Parameters:

algoName - name of the algo, e.g. "GBM"; used for messages and for building the grid key

baseParms - ModelBuilder parameter values that are common across all models in the search

searchParms - hyperparameter search space

Returns:

the started hyperparameter search job

hyperparameterSearch

public water.Job<hex.grid.Grid> hyperparameterSearch(water.Key<hex.grid.Grid> gridKey,
                                            java.lang.String algoName,
                                            hex.Model.Parameters baseParms,
                                            java.util.Map<java.lang.String,java.lang.Object[]> searchParms)

Do a random hyperparameter search. Caller must eventually do a get() on the returned Job to ensure that it's complete.

Parameters:

gridKey - optional grid key

algoName - name of the algo, e.g. "GBM"; used for messages and for building the grid key if it's not specified

baseParms - ModelBuilder parameter values that are common across all models in the search

searchParms - hyperparameter search space

Returns:

the started hyperparameter search job

defaultSearchGLM

public water.Job<hex.grid.Grid> defaultSearchGLM()

defaultSearchGBM

public water.Job<hex.grid.Grid> defaultSearchGBM(water.Key<hex.grid.Grid> gridKey)

defaultSearchDL1

public water.Job<hex.grid.Grid> defaultSearchDL1()

defaultSearchDL2

public water.Job<hex.grid.Grid> defaultSearchDL2()

defaultSearchDL3

public water.Job<hex.grid.Grid> defaultSearchDL3()

learn

public void learn()

startAutoML

public static AutoML startAutoML(AutoMLBuildSpec buildSpec)

Instantiate an AutoML object and start it running. Progress can be tracked via its job().

Parameters:

buildSpec -

Returns:

startAutoML

public static void startAutoML(AutoML aml)

Takes in an AutoML instance and starts running it. Progress can be tracked via its job().

Parameters:

aml -

get

public void get()

Holds until AutoML's job is completed, if a job exists.

delete

public void delete()

Delete the AutoML-related objects, but leave the grids and models that it built.

Overrides:

delete in class water.Lockable<AutoML>

deleteWithChildren

public void deleteWithChildren()

Same as delete() but also deletes all Objects made from this instance.

job

public water.Job job()

leaderboard

public Leaderboard leaderboard()

leader

public hex.Model leader()

userFeedback

public UserFeedback userFeedback()

projectName

public java.lang.String projectName()

addModels

public void addModels(water.Key<hex.Model>[] newModels)

addModel

public void addModel(water.Key<hex.Model> newModel)

addModel

public void addModel(hex.Model newModel)

makeSchema

public java.lang.Class<AutoML.AutoMLKeyV3> makeSchema()

Overrides:

makeSchema in class water.Keyed<AutoML>

possiblyVerifyImmutability

public boolean possiblyVerifyImmutability()