hex.schemas

Class ModelBuilderSchema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>,P extends ModelParametersSchemaV3>

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

water.api.schemas3.RequestSchemaV3<B,S>

hex.schemas.ModelBuilderSchema<B,S,P>

All Implemented Interfaces:

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

Direct Known Subclasses:

ClusteringModelBuilderSchema, QuantileV3

public class ModelBuilderSchema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>,P extends ModelParametersSchemaV3>
extends RequestSchemaV3<B,S>
implements SpecifiesHttpResponseCode

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelBuilderSchema.IcedHashMapStringModelBuilderSchema

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
int	__http_status
java.lang.String	algo
java.lang.String	algo_full_name
hex.ModelCategory[]	can_build
int	error_count
JobV3	job
ValidationMessageV3[]	messages
P	parameters
boolean	supervised
ModelBuilder.BuilderVisibility	visibility

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

Method Summary

Modifier and Type	Method and Description
B	createImpl() Create the corresponding impl object, as well as its parameters object.
P	createParametersSchema() Factory method to create the model-specific parameters schema.
S	fillFromImpl(B builder) Fill this Schema from the given implementation object.
S	fillFromParms(java.util.Properties parms) Fill this Schema object from a set of parameters.
B	fillImpl(B impl) Fill an impl object and any children from this schema and its children.
int	httpStatus()
void	setHttpStatus(int status)
AutoBuffer	writeJSON_impl(AutoBuffer ab)

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, 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

Field Detail

parameters

@API(help="Model builder parameters.")
public P extends ModelParametersSchemaV3 parameters

algo

@API(help="The algo name for this ModelBuilder.",
     direction=OUTPUT)
public java.lang.String algo

algo_full_name

@API(help="The pretty algo name for this ModelBuilder (e.g., Generalized Linear Model, rather than GLM).",
     direction=OUTPUT)
public java.lang.String algo_full_name

can_build

@API(help="Model categories this ModelBuilder can build.",
     values={"Unknown","Binomial","Ordinal","Multinomial","Regression","Clustering","AutoEncoder","DimReduction"},
     direction=OUTPUT)
public hex.ModelCategory[] can_build

supervised

@API(help="Indicator whether the model is supervised or not.",
     direction=OUTPUT)
public boolean supervised

visibility

@API(help="Should the builder always be visible, be marked as beta, or only visible if the user starts up with the experimental flag?",
     values={"Experimental","Beta","AlwaysVisible"},
     direction=OUTPUT)
public ModelBuilder.BuilderVisibility visibility

job

@API(help="Job Key",
     direction=OUTPUT)
public JobV3 job

messages

@API(help="Parameter validation messages",
     direction=OUTPUT)
public ValidationMessageV3[] messages

error_count

@API(help="Count of parameter validation errors",
     direction=OUTPUT)
public int error_count

__http_status

@API(help="HTTP status to return for this build.",
     json=false,
     direction=OUTPUT)
public int __http_status

Constructor Detail

ModelBuilderSchema

public ModelBuilderSchema()

Method Detail

setHttpStatus

public void setHttpStatus(int status)

httpStatus

public int httpStatus()

Specified by:

httpStatus in interface SpecifiesHttpResponseCode

createParametersSchema

public final P createParametersSchema()

Factory method to create the model-specific parameters schema.

fillFromParms

public S fillFromParms(java.util.Properties parms)

Description copied from class: Schema

Fill this Schema object from a set of parameters.

Overrides:

fillFromParms in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>

Parameters:

parms - parameters - set of tuples (parameter name, parameter value)

Returns:

this schema

See Also:

Schema.fillFromParms(Properties, Properties, boolean)

createImpl

public final B createImpl()

Create the corresponding impl object, as well as its parameters object.

Overrides:

createImpl in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>

fillImpl

public B fillImpl(B impl)

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<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>

fillFromImpl

public S fillFromImpl(B builder)

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<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>

writeJSON_impl

public final AutoBuffer writeJSON_impl(AutoBuffer ab)