Parameter Object
Last updated
Last updated
A parameter is a variable that can affect a single experiment trial. SigOpt will suggest values for your parameters in order to optimize the relevant objective. double
and int
parameters represent numeric values. categorical
parameters take on one of a fixed list of values (similar to an enum in many programming languages).
Key | Type | Value |
---|---|---|
bounds
A range of values that a parameter can occupy. Only applicable for parameters of type double
or int
.
categorical_values
array<
Categorical Value
>
A list of categorical values. Only applicable for parameters of type categorical
.
conditions
See conditionals.
default_value
string or number
Used to replace missing parameter assignments in parameters added after initial experiment creation.
grid
array<double>
Only applicable for parameters of type double
and int
. The discrete numerical values that a parameter can take. When grid
is provided, bounds
should not be set. Refer to the Grid Values documentation for more information.
name
string
A user-specified name for this parameter.
precision
int
Only applicable for parameters of type double
. The number of decimal places when displaying on the web dashboard.
prior
Only applicable for parameters of type double
. The prior distribution of the parameter. Refer to the Prior Beliefs documentation for more information.
transformation
string
Only applicable to parameters of type double
. The scale of a parameter. Refer to the Parameter transformation documentation for more information.
type
string
The type of this parameter. Must be one of double
, int
, or categorical
.