public class ModelParameterSchemaV3 extends SchemaV3<Iced,ModelParameterSchemaV3>
SchemaV3.Meta
Schema.AutoParseable
Modifier and Type | Field and Description |
---|---|
Iced |
actual_value |
Iced |
default_value |
boolean |
gridable |
java.lang.String |
help |
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 |
Constructor and Description |
---|
ModelParameterSchemaV3() |
ModelParameterSchemaV3(ModelParametersSchemaV3 schema,
ModelParametersSchemaV3 default_schema,
java.lang.reflect.Field f)
TODO: refactor using SchemaMetadata.
|
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.
|
createAndFillImpl, extractVersionFromSchemaName, fillFromBody, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillImpl, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall
asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal
@API(help="help for the UI, e.g. \"regularization multiplier, typically used for foo bar baz etc.\"", direction=OUTPUT) public java.lang.String help
@API(help="actual value as set by the user and / or modified by the ModelBuilder, e.g., 10", direction=OUTPUT) public Iced actual_value
@API(help="the importance of the parameter, used by the UI, e.g. \"critical\", \"extended\" or \"expert\"", direction=OUTPUT) public java.lang.String level
@API(help="list of valid values for use by the front-end", direction=OUTPUT) public java.lang.String[] values
@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_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_mutually_exclusive_with
public ModelParameterSchemaV3()
public ModelParameterSchemaV3(ModelParametersSchemaV3 schema, ModelParametersSchemaV3 default_schema, java.lang.reflect.Field f)
public ModelParameterSchemaV3 fillFromImpl(Iced iced)
Schema
fillFromImpl
in class Schema<Iced,ModelParameterSchemaV3>
public Iced createImpl()
Schema
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.
createImpl
in class Schema<Iced,ModelParameterSchemaV3>
public final AutoBuffer writeJSON_impl(AutoBuffer ab)
ab
-