water.api.schemas3

Class ModelExportV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<I,S>

water.api.schemas3.RequestSchemaV3<Iced,ModelExportV3>

water.api.schemas3.ModelExportV3

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, ModelExportAware, Freezable

public class ModelExportV3
extends RequestSchemaV3<Iced,ModelExportV3>
implements ModelExportAware

Model export REST end-point.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.schemas3.SchemaV3

SchemaV3.Meta

Nested classes/interfaces inherited from class water.api.Schema

Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	dir Destination directory to save exported model.
boolean	export_cross_validation_predictions
boolean	force Destination directory to save exported model.
KeyV3.ModelKeyV3	model_id Model to export.

Fields inherited from class water.api.schemas3.RequestSchemaV3

_exclude_fields

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
ModelExportV3()

Method Summary

Modifier and Type	Method and Description
boolean	isExportCVPredictionsEnabled()

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillFromParms, fillImpl, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall

Methods inherited from class water.Iced

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface water.api.ModelExportAware

getModelExportOptions

Field Detail

model_id

@API(help="Name of Model of interest",
     json=false)
public KeyV3.ModelKeyV3 model_id

Model to export.

dir

@API(help="Destination file (hdfs, s3, local)")
public java.lang.String dir

Destination directory to save exported model.

force

@API(help="Overwrite destination file in case it exists or throw exception if set to false.")
public boolean force

Destination directory to save exported model.

export_cross_validation_predictions

@API(direction=INPUT,
     help="Flag indicating whether the exported model artifact should also include CV Holdout Frame predictions",
     level=secondary)
public boolean export_cross_validation_predictions

Constructor Detail

ModelExportV3

public ModelExportV3()

Method Detail

isExportCVPredictionsEnabled

public boolean isExportCVPredictionsEnabled()

Specified by:

isExportCVPredictionsEnabled in interface ModelExportAware