hex

Class ParallelModelBuilder

java.lang.Object

jsr166y.ForkJoinTask<ParallelModelBuilder>

hex.ParallelModelBuilder

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.Future<ParallelModelBuilder>

public class ParallelModelBuilder
extends ForkJoinTask<ParallelModelBuilder>

Dispatcher for parallel model building. Starts building models every time the run method is invoked. After each model is finished building, the `modelFinished` method is invoked, which in turn invokes modelFeeder callback. ModelFeeder receives the model built and can deal with it in any way - e.g. put it into a Grid, or discard it if the resulting model is a failure. It also has the power to invoke the training of any number of new models. Or stop the parallel model builder, released the barrier inside.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParallelModelBuilder.ModelBuildFailure Contains all the necessary information after a model builder has failed to build the model
static class	ParallelModelBuilder.ParallelModelBuilderCallback<D extends ParallelModelBuilder.ParallelModelBuilderCallback>

Constructor Summary

Constructors

Constructor and Description
ParallelModelBuilder(ParallelModelBuilder.ParallelModelBuilderCallback callback)

Method Summary

Modifier and Type	Method and Description
protected boolean	exec() Immediately performs the base action of this task and returns true if, upon return from this method, this task is guaranteed to have completed normally.
ParallelModelBuilder	getRawResult() Returns the result that would be returned by ForkJoinTask.join(), even if this task completed abnormally, or null if this task is not known to have been completed.
void	run(java.util.Collection<ModelBuilder> modelBuilders) Runs given collection of ModelBuilder in parallel.
protected void	setRawResult(ParallelModelBuilder value) Forces the given value to be returned as a result.

Methods inherited from class jsr166y.ForkJoinTask

adapt, adapt, adapt, cancel, compareAndSetForkJoinTaskTag, complete, completeExceptionally, fork, get, get, get, getException, getForkJoinTaskTag, getPool, getQueuedTaskCount, getSurplusQueuedTaskCount, helpQuiesce, inForkJoinPool, invoke, invokeAll, invokeAll, invokeAll, isCancelled, isCompletedAbnormally, isCompletedNormally, isDone, join, peekNextLocalTask, pollNextLocalTask, pollTask, quietlyComplete, quietlyInvoke, quietlyJoin, reinitialize, setForkJoinTaskTag, tryUnfork

Methods inherited from class java.lang.Object

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

Constructor Detail

ParallelModelBuilder

public ParallelModelBuilder(ParallelModelBuilder.ParallelModelBuilderCallback callback)

Method Detail

run

public void run(java.util.Collection<ModelBuilder> modelBuilders)

Runs given collection of ModelBuilder in parallel. After each model is finished building, one of the callbacks (on model failure / on model completion) is called.

Parameters:

modelBuilders - An Collection of ModelBuilder to execute in parallel.

getRawResult

public ParallelModelBuilder getRawResult()

Description copied from class: ForkJoinTask

Returns the result that would be returned by ForkJoinTask.join(), even if this task completed abnormally, or null if this task is not known to have been completed. This method is designed to aid debugging, as well as to support extensions. Its use in any other context is discouraged.

Specified by:

getRawResult in class ForkJoinTask<ParallelModelBuilder>

Returns:

the result, or null if not completed

setRawResult

protected void setRawResult(ParallelModelBuilder value)

Description copied from class: ForkJoinTask

Forces the given value to be returned as a result. This method is designed to support extensions, and should not in general be called otherwise.

Specified by:

setRawResult in class ForkJoinTask<ParallelModelBuilder>

Parameters:

value - the value

exec

protected boolean exec()

Description copied from class: ForkJoinTask

Immediately performs the base action of this task and returns true if, upon return from this method, this task is guaranteed to have completed normally. This method may return false otherwise, to indicate that this task is not necessarily complete (or is not known to be complete), for example in asynchronous actions that require explicit invocations of completion methods. This method may also throw an (unchecked) exception to indicate abnormal exit. This method is designed to support extensions, and should not in general be called otherwise.

Specified by:

exec in class ForkJoinTask<ParallelModelBuilder>

Returns:

true if this task is known to have completed normally