ai.h2o.mojos.runtime

Class MojoPipeline

java.lang.Object

ai.h2o.mojos.runtime.MojoPipeline

All Implemented Interfaces:

java.io.Serializable

public abstract class MojoPipeline
extends java.lang.Object
implements java.io.Serializable

This class represents the MOJO scoring pipeline.

It transforms an instance of MojoFrame and produces a new MojoFrame.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MojoPipeline(java.lang.String uuid, org.joda.time.DateTime timestamp, java.lang.String license)

Method Summary

Modifier and Type	Method and Description
org.joda.time.DateTime	getCreationTime() Get the creation time of the mojo file
protected abstract MojoFrameBuilder	getFrameBuilder(MojoColumn.Kind kind)
MojoFrameBuilder	getInputFrameBuilder() Get an instance of an MojoFrameBuilder that can be used to make an input frame
MojoFrameMeta	getInputMeta() Get the meta data for the input frame (see MojoFrameMeta
java.lang.String	getLicense() Get the license of the mojo file
protected abstract MojoFrameMeta	getMeta(MojoColumn.Kind kind)
MojoFrameMeta	getOutputMeta() Get the meta data for the output frame (see MojoFrameMeta
java.lang.String	getUuid() Get the pipeline’s uuid, if stated in the creation file.
static MojoPipeline	loadFrom(MojoReaderBackend mrb) Deprecated. use MojoPipelineService.loadPipeline(ReaderBackend) instead
static MojoPipeline	loadFrom(java.lang.String file) Deprecated. use MojoPipelineService.loadPipeline(File) instead
void	setShapPredictContrib(boolean enable) Allows prediction contribution columns (computed by SHAP algo) to appear in the transformation result.
MojoFrame	transform(MojoFrame inputFrame) Executes the pipeline of transformers as stated in this model’s mojo file.
MojoFrame	transform(MojoFrameBuilder inputFrameBuilder) Executes the pipeline of transformers as stated in this model’s mojo file.
abstract MojoFrame	transform(MojoFrame inputFrame, MojoFrame outputFrame) Executes the pipeline of transformers as stated in this model’s mojo file.

Methods inherited from class java.lang.Object

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

Constructor Detail

MojoPipeline

protected MojoPipeline(java.lang.String uuid,
                       org.joda.time.DateTime timestamp,
                       java.lang.String license)

Method Detail

loadFrom

@Deprecated
public static MojoPipeline loadFrom(java.lang.String file)
                                         throws java.io.IOException,
                                                LicenseException

Deprecated. use MojoPipelineService.loadPipeline(File) instead

Instantiate MojoPipeline from the provided .mojo file. This is the primary method for creating MojoPipeline instances.

Parameters:

file - Name of the .mojo file with saved model information.

Returns:

New MojoPipeline instance that is built according to the description in the .mojo file.

Throws:

java.io.IOException - In case the file cannot be read, or has invalid format, or is not a Mojo-2 file.

LicenseException

loadFrom

@Deprecated
public static MojoPipeline loadFrom(MojoReaderBackend mrb)
                                         throws java.io.IOException,
                                                LicenseException

Deprecated. use MojoPipelineService.loadPipeline(ReaderBackend) instead

Throws:

java.io.IOException

LicenseException

getUuid

public java.lang.String getUuid()

Get the pipeline’s uuid, if stated in the creation file.

Returns:

The model’s uuid

getCreationTime

public org.joda.time.DateTime getCreationTime()

Get the creation time of the mojo file

Returns:

The mojo file’s creation time

getLicense

public java.lang.String getLicense()

Get the license of the mojo file

Returns:

the mojo file’s license

getInputFrameBuilder

public MojoFrameBuilder getInputFrameBuilder()

Get an instance of an MojoFrameBuilder that can be used to make an input frame

Returns:

A new input frame builder

getFrameBuilder

protected abstract MojoFrameBuilder getFrameBuilder(MojoColumn.Kind kind)

getInputMeta

public MojoFrameMeta getInputMeta()

Get the meta data for the input frame (see MojoFrameMeta

Returns:

The input frame meta data

getOutputMeta

public MojoFrameMeta getOutputMeta()

Get the meta data for the output frame (see MojoFrameMeta

Returns:

The output frame meta data

getMeta

protected abstract MojoFrameMeta getMeta(MojoColumn.Kind kind)

transform

public MojoFrame transform(MojoFrameBuilder inputFrameBuilder)

Executes the pipeline of transformers as stated in this model’s mojo file.

Parameters:

inputFrameBuilder - A MojoFrameBuilder from which an input frame can be retrieved

Returns:

A MojoFrame containing the results of the transform pipeline

transform

public MojoFrame transform(MojoFrame inputFrame)

Executes the pipeline of transformers as stated in this model’s mojo file.

Parameters:

inputFrame - A MojoFrame containing the input data

Returns:

A MojoFrame containing the results of the transform pipeline

To Do#1

mark this method final after https://github.com/h2oai/dai-deployment-templates/pull/172 is merged

transform

public abstract MojoFrame transform(MojoFrame inputFrame,
                                    MojoFrame outputFrame)

Executes the pipeline of transformers as stated in this model’s mojo file.

Parameters:

inputFrame - A MojoFrame containing the input data

outputFrame - A MojoFrame to which the results of the transform pipeline should be written

Returns:

outputFrame reference

setShapPredictContrib

public void setShapPredictContrib(boolean enable)

Allows prediction contribution columns (computed by SHAP algo) to appear in the transformation result. Current implementation removes the standard transformation result. This will be improved in future.

Parameters:

enable -

• currently required to be true.