water.api

Class ModelParameterSchemaV2

java.lang.Object

water.Iced

water.api.Schema<Iced,ModelParameterSchemaV2>

water.api.ModelParameterSchemaV2

All Implemented Interfaces:

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).

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	actual_value
java.lang.String	default_value
java.lang.String[]	dependencies
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[]	validation
java.lang.String[]	values

Constructor Summary

Constructors

Constructor and Description
ModelParameterSchemaV2()
ModelParameterSchemaV2(ModelParametersSchema schema, ModelParametersSchema default_schema, java.lang.reflect.Field f)

Method Summary

Methods

Modifier and Type	Method and Description
Iced	createImpl()
ModelParameterSchemaV2	fillFromImpl(Iced iced)

Methods inherited from class water.api.Schema

acceptsFrame, fillFromParms

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readJSON_impl, readJSON, write_impl, write, 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\"")
public java.lang.String name

label

@API(help="label in the UI, e.g. \"lambda\"")
public java.lang.String label

help

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

required

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

type

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

default_value

@API(help="default value, e.g. 1")
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")
public java.lang.String actual_value

level

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

dependencies

@API(help="other fields that must be set before setting this one, e.g. \"response_column\"")
public java.lang.String[] dependencies

validation

@API(help="list of validation expressions for use by the front-end and back-end")
public java.lang.String[] validation

values

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

Constructor Detail

ModelParameterSchemaV2

public ModelParameterSchemaV2()

ModelParameterSchemaV2

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

Method Detail

fillFromImpl

public ModelParameterSchemaV2 fillFromImpl(Iced iced)

Specified by:

fillFromImpl in class Schema<Iced,ModelParameterSchemaV2>

createImpl

public Iced createImpl()

Specified by:

createImpl in class Schema<Iced,ModelParameterSchemaV2>