jsat.parameters

Annotation Type Parameter.WarmParameter

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public static @interface Parameter.WarmParameter

Adding this annotation to a method tells the Parameter.getParamsFromMethods(java.lang.Object) method to consider the Parameter object generated for that method a preferred parameter for warm starting.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
boolean	prefLowToHigh Indicates the ordering that would be preferred by the algorithm when training.

Element Detail

prefLowToHigh

public abstract boolean prefLowToHigh

Indicates the ordering that would be preferred by the algorithm when training.

It may be the case that the model has no preference for models to be trained from low to high or high to low, in which case any arbitrary value may be returned - so long as it consistently returns the same value.

Returns:

true if it is preferred to train from low values of the parameter to high values of the parameter. false is returned if it is preferred to go from high to low values.