water.api

Class ModelParameterSchemaV2

java.lang.Object

water.Iced

water.api.Schema<Iced,ModelParameterSchemaV2>

water.api.ModelParameterSchemaV2

All Implemented Interfaces:

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

public class ModelParameterSchemaV2
extends Schema<Iced,ModelParameterSchemaV2>

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	actual_value
java.lang.String	default_value
java.lang.String	help
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.Schema

_version_pattern, schema_name, schema_type, schema_version

Constructor Summary

Constructors

Constructor and Description
ModelParameterSchemaV2()
ModelParameterSchemaV2(ModelParametersSchema schema, ModelParametersSchema default_schema, java.lang.reflect.Field f) TODO: refactor using SchemaMetadata.

Method Summary

Methods

Modifier and Type	Method and Description
Iced	createImpl() Create an implementation object and any child objects but DO NOT fill them.
ModelParameterSchemaV2	fillFromImpl(Iced iced) Version and Schema-specific filling from the implementation object.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, extractVersion, fillFromParms, fillImpl, getImplClass, getImplClass, markdown, markdown, register

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, write_impl, write, writeExternal, writeHTML_impl, writeHTML, writeJSON_impl, writeJSON

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="label in the UI, e.g. \"lambda\"",
     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 java.lang.String 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 java.lang.String actual_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

Constructor Detail

ModelParameterSchemaV2

public ModelParameterSchemaV2()

ModelParameterSchemaV2

public ModelParameterSchemaV2(ModelParametersSchema schema,
                      ModelParametersSchema default_schema,
                      java.lang.reflect.Field f)

TODO: refactor using SchemaMetadata.

Method Detail

fillFromImpl

public ModelParameterSchemaV2 fillFromImpl(Iced iced)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<Iced,ModelParameterSchemaV2>

createImpl

public Iced createImpl()

Description copied from class: Schema

Create an implementation object and any child objects but DO NOT fill them. The 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,ModelParameterSchemaV2>