Package ai.h2o.mojos.runtime.frame

The package exposes classes to support frame and row creation.

See: Description

Interface Summary

Interface	Description
MojoColumnFactory	Column factory.
StringConverter	StringConverter is an interface for converting String values into a MojoColumn.Type.

Class Summary

Class	Description
MojoColumn	Container for values across a column in a MojoFrame.
MojoFrame	Container for MojoColumns as well as some additional meta data.
MojoFrameBuilder	The builder is used for constructing a MojoFrame.
MojoFrameMeta	MojoFrame meta data
MojoRowBuilder	The builder is used to build rows for a MojoFrameBuilder.

Enum Summary

Enum	Description
MojoColumn.Kind
MojoColumn.Type	MojoColumn Type Enum

Package ai.h2o.mojos.runtime.frame Description

The package exposes classes to support frame and row creation.

The package expose the following concepts:

• MojoFrame
• MojoFrameBuilder
• MojoRowBuilder

The MojoFrame represents data which are transformed by MojoPipeline. The frame consists of columns MojoColumn, each column has defined type MojoColumn.Type.

The MojoFrame is constructed with help of MojoFrameBuilder. The builder which helps to create input frame for a given MOJO pipeline can be obtain by calling MojoPipeline.getInputFrameBuilder().

The frame builder provides a method MojoFrameBuilder.getMojoRowBuilder() to obtain an instance of MojoRowBuilder. The row builder helps to create representation of row. The row constructed by the row builder, is appended to the frame builder by calling method MojoFrameBuilder.addRow(ai.h2o.mojos.runtime.frame.MojoRowBuilder).

The row can be constructed in two ways:

• by passing a string representation of value for a particular column to method MojoRowBuilder.setValue(int, java.lang.String). This method internally transform the string representation into actual column type
• by using a strongly typed methods setX(int columnIndex, X value) where X is Java type compatible with MOJO column type. For example, MojoRowBuilder.setBool(int, java.lang.Boolean) allows to set boolean value for a given column.

Note: Instances of MojoRowBuilder can be reused after calling MojoRowBuilder

Example:

Given a pipeline modelPipeline we can construct an input frame in the following way:

// Get an input frame builder for given modelPipeline
MojoFrameBuilder frameBuilder = modelPipeline.getInputFrameBuilder();

// Create a new row builder
MojoRowBuilder rowBuilder = frameBuilder.getMojoRowBuilder();
rowBuilder.setValue("AGE", "68");
rowBuilder.setValue("RACE", "2");
rowBuilder.setValue("DCAPS", "2");
rowBuilder.setValue("VOL", "0");
rowBuilder.setValue("GLEASON", "6");
frameBuilder.addRow(rowBuilder);

// Create a frame which can be transformed by MOJO pipeline
MojoFrame iframe = frameBuilder.toMojoFrame();

// Transform frame by the given modelPipeline:
MojoFrame oframe = modelPipeline.transform(iframe);