Parameter Object

A parameter is a variable that can affect a single experiment trial. SigOpt will suggest values for your parameters in order to maximize 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).

Fields

KeyTypeValue
boundsBoundsThe bounds for this parameter. Only applicable to parameters of type double or int.
categorical_valuesarray<Categorical Value>A list of categorical values. Only applicable for parameters of type categorical.
conditionsConditionsSee conditionals.
default_valuestring or numberUsed to replace missing parameter assignments in parameters added after initial experiment creation.
namestringA user-specified name for this parameter.
precisionintOnly applicable to parameters of type double. The number of decimal places considered when optimizing.
typestringThe type of this parameter. Must be one of double, int, or categorical.

Examples

Double Parameter

{
  "bounds": {
    "max": 1,
    "min": 0.001,
    "object": "bounds"
  },
  "categorical_values": null,
  "conditions": {},
  "default_value": null,
  "name": "gamma",
  "object": "parameter",
  "precision": null,
  "tunable": true,
  "type": "double"
}

Integer Parameter

{
  "bounds": {
    "max": 5,
    "min": 1,
    "object": "bounds"
  },
  "categorical_values": null,
  "conditions": {},
  "default_value": null,
  "name": "degree",
  "object": "parameter",
  "precision": null,
  "tunable": true,
  "type": "int"
}

Categorical Parameter

{
  "bounds": null,
  "categorical_values": [
    {
      "enum_index": 1,
      "name": "rbf",
      "object": "categorical_value"
    },
    {
      "enum_index": 2,
      "name": "poly",
      "object": "categorical_value"
    },
    {
      "enum_index": 3,
      "name": "sigmoid",
      "object": "categorical_value"
    }
  ],
  "conditions": {},
  "default_value": null,
  "name": "kernel",
  "object": "parameter",
  "precision": null,
  "tunable": true,
  "type": "categorical"
}