water.api.schemas3

Class ModelParameterSchemaV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<Iced,ModelParameterSchemaV3>

water.api.schemas3.ModelParameterSchemaV3

All Implemented Interfaces:

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

public class ModelParameterSchemaV3
extends SchemaV3<Iced,ModelParameterSchemaV3>

An instance of a ModelParameters schema contains the metadata for a single Model build parameter (e.g., K for KMeans). TODO: add a superclass. TODO: refactor this into with FieldMetadataBase.

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
Iced	actual_value
Iced	default_value
boolean	gridable
java.lang.String	help
Iced	input_value
java.lang.String[]	is_member_of_frames
java.lang.String[]	is_mutually_exclusive_with
java.lang.String	label
java.lang.String	level
java.lang.String	name
boolean	required
java.lang.String	type
java.lang.String[]	values

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
ModelParameterSchemaV3()
ModelParameterSchemaV3(ModelParametersSchemaV3 schema, ModelParametersSchemaV3 input_schema, ModelParametersSchemaV3 default_schema, java.lang.reflect.Field f) TODO: refactor using SchemaMetadata.

Method Summary

Modifier and Type	Method and Description
Iced	createImpl() Create an appropriate implementation object and any child objects but does not fill them.
ModelParameterSchemaV3	fillFromImpl(Iced iced) Fill this Schema from the given implementation object.
AutoBuffer	writeJSON_impl(AutoBuffer ab) ModelParameterSchema has its own serializer so that default_value and actual_value get serialized as their native types.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

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

Field Detail

name

@API(help="name in the JSON, e.g. \"lambda\"",
     direction=OUTPUT)
public java.lang.String name

label

@API(help="[DEPRECATED] same as name.",
     direction=OUTPUT)
public java.lang.String label

help

@API(help="help for the UI, e.g. \"regularization multiplier, typically used for foo bar baz etc.\"",
     direction=OUTPUT)
public java.lang.String help

required

@API(help="the field is required",
     direction=OUTPUT)
public boolean required

type

@API(help="Java type, e.g. \"double\"",
     direction=OUTPUT)
public java.lang.String type

default_value

@API(help="default value, e.g. 1",
     direction=OUTPUT)
public Iced default_value

actual_value

@API(help="actual value as set by the user and / or modified by the ModelBuilder, e.g., 10",
     direction=OUTPUT)
public Iced actual_value

input_value

@API(help="input value as set by the user, e.g., 10",
     direction=OUTPUT)
public Iced input_value

level

@API(help="the importance of the parameter, used by the UI, e.g. \"critical\", \"extended\" or \"expert\"",
     direction=OUTPUT)
public java.lang.String level

values

@API(help="list of valid values for use by the front-end",
     direction=OUTPUT)
public java.lang.String[] values

is_member_of_frames

@API(help="For Vec-type fields this is the set of Frame-type fields which must contain the named column; for example, for a SupervisedModel the response_column must be in both the training_frame and (if it\'s set) the validation_frame")
public java.lang.String[] is_member_of_frames

is_mutually_exclusive_with

@API(help="For Vec-type fields this is the set of other Vec-type fields which must contain mutually exclusive values; for example, for a SupervisedModel the response_column must be mutually exclusive with the weights_column")
public java.lang.String[] is_mutually_exclusive_with

gridable

@API(help="Parameter can be used in grid call",
     direction=OUTPUT)
public boolean gridable

Constructor Detail

ModelParameterSchemaV3

public ModelParameterSchemaV3()

ModelParameterSchemaV3

public ModelParameterSchemaV3(ModelParametersSchemaV3 schema,
                              ModelParametersSchemaV3 input_schema,
                              ModelParametersSchemaV3 default_schema,
                              java.lang.reflect.Field f)

TODO: refactor using SchemaMetadata.

Method Detail

fillFromImpl

public ModelParameterSchemaV3 fillFromImpl(Iced iced)

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<Iced,ModelParameterSchemaV3>

createImpl

public Iced createImpl()

Description copied from class: Schema

Create an appropriate implementation object and any child objects but does not fill them. The standard purpose of a createImpl without a fillImpl is to be able to get the default values for all the impl's fields.

For objects without children this method does all the required work. For objects with children the subclass will need to override, e.g. by calling super.createImpl() and then calling createImpl() on its children.

Note that impl objects for schemas which override this method don't need to have a default constructor (e.g., a Keyed object constructor can still create and set the Key), but they must not fill any fields which can be filled later from the schema.

TODO: We could handle the common case of children with the same field names here by finding all of our fields that are themselves Schemas.

Overrides:

createImpl in class Schema<Iced,ModelParameterSchemaV3>

writeJSON_impl

public final AutoBuffer writeJSON_impl(AutoBuffer ab)

ModelParameterSchema has its own serializer so that default_value and actual_value get serialized as their native types. Autobuffer assumes all classes that have their own serializers should be serialized as JSON objects, and wraps them in {}, so this can't just be handled by a customer serializer in IcedWrapper.

Parameters:

ab -

Returns: