hex.createframe

Class CreateFrameExecutor

java.lang.Object

jsr166y.ForkJoinTask<java.lang.Void>

jsr166y.CountedCompleter

water.H2O.H2OCountedCompleter<CreateFrameExecutor>

hex.createframe.CreateFrameExecutor

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.concurrent.Future<java.lang.Void>, Freezable<CreateFrameExecutor>

public class CreateFrameExecutor
extends H2O.H2OCountedCompleter<CreateFrameExecutor>

This class carries out the frame creation job.

Frame creation is conceptually done in 3 stages: First, a build "recipe" is prepared. This recipe is the detailed specification of how the frame is to be constructed. Second, an MRTask is run that actually creates the frame, according to the specification in the recipe. In this step all "column makers" are executed in order they were added, for each chunk-row being created. Finally, a set of postprocessing steps are performed on the resulting frame.

Usage example:

   Job<Frame> job = new Job<>(destination_key, Frame.class.getName(), "CreateFrame");
   CreateFrameExecutor cfe = new CreateFrameExecutor(job);
   cfe.setNumRows(10000);
   cfe.setSeed(0xDECAFC0FEE);
   cfe.addColumnMaker(new RealColumnCfcm("col0", -1, 1));
   cfe.addColumnMaker(new IntegerColumnCfcm("col1", 0, 100));
   cfe.addPostprocessStep(new MissingInserterCfps(0.05));
   job.start(cfe, cfe.workAmount());
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateFrameExecutor(Job<Frame> job) Make a new CreateFrameExecutor.

Method Summary

Modifier and Type	Method and Description
void	addColumnMaker(CreateFrameColumnMaker maker) Add a "column maker" task, responsible for creation of a single (rarely married or widowed) column.
void	addPostprocessStep(CreateFramePostprocessStep step) Add a step to be performed in the end after the frame has been created.
void	compute2() Override compute3() with actual work without having to worry about tryComplete()
long	estimatedByteSize() Estimated size of the frame (in bytes), to be used in determining the optimal chunk size.
void	setNumRows(int n) Set number of rows to be created in the resulting frame.
void	setSeed(long s) Set the seed for the random number generator.
int	workAmount() Return total amount of work that will be performed by the executor.

Methods inherited from class water.H2O.H2OCountedCompleter

asBytes, clone, compute, compute1, currThrPriority, frozenType, icer, priority, read, readJSON, reloadFromBytes, write, writeJSON

Methods inherited from class jsr166y.CountedCompleter

__tryComplete, addToPendingCount, compareAndSetPendingCount, complete, exec, getCompleter, getPendingCount, getRawResult, onCompletion, onExceptionalCompletion, setCompleter, setPendingCount, setRawResult, tryComplete

Methods inherited from class jsr166y.ForkJoinTask

adapt, adapt, adapt, cancel, compareAndSetForkJoinTaskTag, 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

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

Constructor Detail

CreateFrameExecutor

public CreateFrameExecutor(Job<Frame> job)

Make a new CreateFrameExecutor.

Parameters:

job - The Job instance which is wrapping this executor. This instance will be used to update it with the current task progress.

Method Detail

setNumRows

public void setNumRows(int n)

Set number of rows to be created in the resulting frame. (However a postprocess step may remove some of the rows).

setSeed

public void setSeed(long s)

Set the seed for the random number generator. Two frames created from the same seed will be identical. Seed value of -1 (the default) means that a random seed will be issued.

addColumnMaker

public void addColumnMaker(CreateFrameColumnMaker maker)

Add a "column maker" task, responsible for creation of a single (rarely married or widowed) column.

addPostprocessStep

public void addPostprocessStep(CreateFramePostprocessStep step)

Add a step to be performed in the end after the frame has been created. This step can then modify the frame in any way.

workAmount

public int workAmount()

Return total amount of work that will be performed by the executor. This is needed externally in the Job execution context to determine the progress if the task if it is long-running.

estimatedByteSize

public long estimatedByteSize()

Estimated size of the frame (in bytes), to be used in determining the optimal chunk size. This estimate may not be absolutely precise.

compute2

public void compute2()

Description copied from class: H2O.H2OCountedCompleter

Override compute3() with actual work without having to worry about tryComplete()

Overrides:

compute2 in class H2O.H2OCountedCompleter<CreateFrameExecutor>