Archived Documentation

Welcome to the developer documentation for SigOpt. If you have a question you can’t answer, feel free to contact us!
You are currently viewing archived SigOpt documentation. The newest documentation can be found here.

Parameter Object

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).

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.
gridarray<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.
namestringA user-specified name for this parameter.
precisionintOnly applicable to parameters of type double. The number of decimal places considered when optimizing.
priorPriorOnly applicable to parameters of type double. The prior distribution of the parameter. Refer to the Prior Beliefs documentation for more information.
transformationstringOnly applicable to parameters of type double. The scale of a parameter. Refer to the Parameter transformation documentation for more information.
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,
  "prior": null,
  "transformation": 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,
  "prior": null,
  "transformation": 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,
  "prior": null,
  "transformation": null,
  "tunable": true,
  "type": "categorical"
}