Parameter Object
A parameter is a variable that can be tracked in association with a Run. In an HPO Experiment, 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
``Bounds
A range of values that a parameter can occupy. Only applicable to parameters of type double or int.
categorical_values
A list of categorical values. Only applicable for parameters of type categorical.
conditions
[`Conditions`](../experiments/parameter\_space.md#define-conditional-parameters)
default_value
string or number
Used to replace missing parameter assignments in parameters added after initial experiment creation.
grid
array<double>
Only applicable to 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 to parameters of type double. The number of decimal places considered when optimizing.
prior
[`Prior`](../experiments/parameter\_space.md#define-prior-distributions)
Only applicable to 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.

Examples

Double Parameter

1
{
2
"bounds": {
3
"max": 1,
4
"min": 0.001,
5
"object": "bounds"
6
},
7
"categorical_values": null,
8
"conditions": {},
9
"default_value": null,
10
"name": "gamma",
11
"object": "parameter",
12
"precision": null,
13
"prior": null,
14
"transformation": null,
15
"tunable": true,
16
"type": "double"
17
}onth
Copied!

Integer Parameter

1
{
2
"bounds": {
3
"max": 5,
4
"min": 1,
5
"object": "bounds"
6
},
7
"categorical_values": null,
8
"conditions": {},
9
"default_value": null,
10
"name": "degree",
11
"object": "parameter",
12
"precision": null,
13
"prior": null,
14
"transformation": null,
15
"tunable": true,
16
"type": "int"
17
}
Copied!

Categorical Parameter

1
{
2
"bounds": null,
3
"categorical_values": [
4
{
5
"enum_index": 1,
6
"name": "rbf",
7
"object": "categorical_value"
8
},
9
{
10
"enum_index": 2,
11
"name": "poly",
12
"object": "categorical_value"
13
},
14
{
15
"enum_index": 3,
16
"name": "sigmoid",
17
"object": "categorical_value"
18
}
19
],
20
"conditions": {},
21
"default_value": null,
22
"name": "kernel",
23
"object": "parameter",
24
"precision": null,
25
"prior": null,
26
"transformation": null,
27
"tunable": true,
28
"type": "categorical"
29
}
Copied!