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

H2O AutoML AutoML is used for automating the machine learning workflow, which includes automatic training and tuning of many models within a user-specified time-limit. Stacked Ensembles will be automatically trained on collections of individual models to produce highly predictive ensemble models which, in most cases, will be the top performing models in the AutoML Leaderboard.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoML.Constraint

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<AutoML>	byStartTime
static java.lang.String	keySeparator

Fields inherited from class water.Lockable

_lockers

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
AutoML() DO NOT USE explicitly: for schema/reflection only.
AutoML(AutoMLBuildSpec buildSpec)
AutoML(java.util.Date startTime, AutoMLBuildSpec buildSpec) Deprecated. use instead
AutoML(water.Key<AutoML> key, AutoMLBuildSpec buildSpec)
AutoML(water.Key<AutoML> key, java.util.Date startTime, AutoMLBuildSpec buildSpec) Deprecated. use instead

Method Summary

Modifier and Type	Method and Description
EventLog	eventLog()
void	get() Holds until AutoML's job is completed, if a job exists.
StepDefinition[]	getActualModelingSteps()
water.fvec.Frame	getBlendingFrame()
AutoMLBuildSpec	getBuildSpec()
double[]	getClassDistribution()
hex.genmodel.utils.DistributionFamily	getDistributionFamily()
water.fvec.Vec	getFoldColumn()
water.fvec.Frame	getLeaderboardFrame()
water.fvec.Vec	getResponseColumn()
water.fvec.Frame	getTrainingFrame()
water.fvec.Frame	getValidationFrame()
water.fvec.Vec	getWeightsColumn()
boolean	isCVEnabled()
water.Job<AutoML>	job()
boolean	keepRunning()
hex.Model	leader()
hex.leaderboard.Leaderboard	leaderboard()
water.Key	makeKey(java.lang.String algoName, java.lang.String type, boolean with_counter)
java.lang.Class<AutoMLV99.AutoMLKeyV3>	makeSchema()
java.lang.String	projectName()
int	remainingModels()
protected water.Futures	remove_impl(water.Futures fs, boolean cascade) Delete the AutoML-related objects, including the grids and models that it built if cascade=true
void	run()
AutoMLSession	session()
static AutoML	startAutoML(AutoMLBuildSpec buildSpec) Instantiate an AutoML object and start it running.
void	stop()
void	submit() Creates a job for the current AutoML instance and submits it to the task runner.
long	timeRemainingMs()
void	trackKeys(water.Key... keys)

Methods inherited from class water.Lockable

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

Methods inherited from class water.Keyed

checksum_impl, checksum_impl, checksum, checksum, getKey, readAll_impl, readAll, remove_impl, remove_self_key_impl, remove, remove, remove, remove, remove, remove, removeQuietly, writeAll_impl, writeAll

Methods inherited from class water.Iced

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

Methods inherited from class java.lang.Object

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

Field Detail

byStartTime

public static final java.util.Comparator<AutoML> byStartTime

keySeparator

public static final java.lang.String keySeparator

See Also:

Constant Field Values

Constructor Detail

AutoML

public AutoML()

DO NOT USE explicitly: for schema/reflection only.

AutoML

public AutoML(AutoMLBuildSpec buildSpec)

AutoML

public AutoML(water.Key<AutoML> key,
              AutoMLBuildSpec buildSpec)

AutoML

@Deprecated
public AutoML(java.util.Date startTime,
                          AutoMLBuildSpec buildSpec)

Deprecated. use instead

AutoML

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

Deprecated. use instead

Method Detail

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:

a new running AutoML instance.

makeSchema

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

Overrides:

makeSchema in class water.Keyed<AutoML>

getBuildSpec

public AutoMLBuildSpec getBuildSpec()

getTrainingFrame

public water.fvec.Frame getTrainingFrame()

getValidationFrame

public water.fvec.Frame getValidationFrame()

getBlendingFrame

public water.fvec.Frame getBlendingFrame()

getLeaderboardFrame

public water.fvec.Frame getLeaderboardFrame()

getResponseColumn

public water.fvec.Vec getResponseColumn()

getFoldColumn

public water.fvec.Vec getFoldColumn()

getWeightsColumn

public water.fvec.Vec getWeightsColumn()

getDistributionFamily

public hex.genmodel.utils.DistributionFamily getDistributionFamily()

getClassDistribution

public double[] getClassDistribution()

getActualModelingSteps

public StepDefinition[] getActualModelingSteps()

submit

public void submit()

Creates a job for the current AutoML instance and submits it to the task runner. Calling this on an already running AutoML instance has no effect.

run

public void run()

Specified by:

run in interface H2ORunnable

stop

public void stop()

Specified by:

stop in interface H2ORunnable

get

public void get()

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

job

public water.Job<AutoML> job()

leader

public hex.Model leader()

session

public AutoMLSession session()

leaderboard

public hex.leaderboard.Leaderboard leaderboard()

eventLog

public EventLog eventLog()

projectName

public java.lang.String projectName()

timeRemainingMs

public long timeRemainingMs()

Specified by:

timeRemainingMs in interface TimedH2ORunnable

remainingModels

public int remainingModels()

keepRunning

public boolean keepRunning()

Specified by:

keepRunning in interface TimedH2ORunnable

isCVEnabled

public boolean isCVEnabled()

makeKey

public water.Key makeKey(java.lang.String algoName,
                         java.lang.String type,
                         boolean with_counter)

trackKeys

public void trackKeys(water.Key... keys)

remove_impl

protected water.Futures remove_impl(water.Futures fs,
                                    boolean cascade)

Delete the AutoML-related objects, including the grids and models that it built if cascade=true

Overrides:

remove_impl in class water.Keyed<AutoML>