water.api.schemas3

Class ModelsV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

water.api.schemas3.RequestSchemaV3<ModelsHandler.Models,ModelsV3>

water.api.schemas3.ModelsV3

All Implemented Interfaces:

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

public class ModelsV3
extends RequestSchemaV3<ModelsHandler.Models,ModelsV3>
implements ModelExportAware

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
FrameV3[]	compatible_frames
boolean	export_cross_validation_predictions
boolean	find_compatible_frames
KeyV3.ModelKeyV3	model_id
ModelSchemaBaseV3[]	models
boolean	preview

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
ModelsV3()

Method Summary

Modifier and Type	Method and Description
ModelsV3	fillFromImpl(ModelsHandler.Models m) Fill this Schema from the given implementation object.
ModelsV3	fillFromImplWithSynopsis(ModelsHandler.Models m)
ModelsHandler.Models	fillImpl(ModelsHandler.Models m) Fill an impl object and any children from this schema and its children.
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, fillFromParms, fillFromParms, fillFromParms, 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

preview

@API(help="Return potentially abridged model suitable for viewing in a browser",
     json=false,
     required=false,
     direction=INPUT)
public boolean preview

find_compatible_frames

@API(help="Find and return compatible frames?",
     json=false,
     direction=INPUT)
public boolean find_compatible_frames

models

@API(help="Models",
     direction=OUTPUT)
public ModelSchemaBaseV3[] models

compatible_frames

@API(help="Compatible frames",
     direction=OUTPUT)
public FrameV3[] compatible_frames

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

ModelsV3

public ModelsV3()

Method Detail

fillImpl

public ModelsHandler.Models fillImpl(ModelsHandler.Models m)

Description copied from class: Schema

Fill an impl object and any children from this schema and its children. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillImpl in class Schema<ModelsHandler.Models,ModelsV3>

fillFromImpl

public ModelsV3 fillFromImpl(ModelsHandler.Models m)

Description copied from class: Schema

Fill this Schema from the given implementation object. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillFromImpl in class Schema<ModelsHandler.Models,ModelsV3>

fillFromImplWithSynopsis

public ModelsV3 fillFromImplWithSynopsis(ModelsHandler.Models m)

isExportCVPredictionsEnabled

public boolean isExportCVPredictionsEnabled()

Specified by:

isExportCVPredictionsEnabled in interface ModelExportAware