public class ModelBuilderSchema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>,P extends ModelParametersSchemaV3> extends RequestSchemaV3<B,S> implements SpecifiesHttpResponseCode
Modifier and Type | Class and Description |
---|---|
static class |
ModelBuilderSchema.IcedHashMapStringModelBuilderSchema |
SchemaV3.Meta
Schema.AutoParseable
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 |
_exclude_fields
Constructor and Description |
---|
ModelBuilderSchema() |
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) |
createAndFillImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall
asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal
@API(help="Model builder parameters.") public P extends ModelParametersSchemaV3 parameters
@API(help="The algo name for this ModelBuilder.", direction=OUTPUT) public java.lang.String algo
@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
@API(help="Model categories this ModelBuilder can build.", values={"Unknown","Binomial","Ordinal","Multinomial","Regression","Clustering","AutoEncoder","DimReduction"}, direction=OUTPUT) public hex.ModelCategory[] can_build
@API(help="Indicator whether the model is supervised or not.", direction=OUTPUT) public boolean supervised
@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
@API(help="Parameter validation messages", direction=OUTPUT) public ValidationMessageV3[] messages
@API(help="Count of parameter validation errors", direction=OUTPUT) public int error_count
public void setHttpStatus(int status)
public int httpStatus()
httpStatus
in interface SpecifiesHttpResponseCode
public final P createParametersSchema()
public S fillFromParms(java.util.Properties parms)
Schema
fillFromParms
in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>
parms
- parameters - set of tuples (parameter name, parameter value)Schema.fillFromParms(Properties, Properties, boolean)
public final B createImpl()
createImpl
in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>
public B fillImpl(B impl)
Schema
fillImpl
in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>
public S fillFromImpl(B builder)
Schema
fillFromImpl
in class Schema<B extends ModelBuilder,S extends ModelBuilderSchema<B,S,P>>
public final AutoBuffer writeJSON_impl(AutoBuffer ab)