Plan Object

A description of the SigOpt features a client has currently enabled. This object is currently in beta and may be changed in the future. For that reason, fields that are undocumented should be considered to be experimental and may disappear without notice.

Fields

Key	Type	Value
current_period	Plan Period	A description of the current time period for this plan.
id	string	A unique identifier for this plan.
name	string	A human-readable description of this plan.
rules	Plan Rules	The features enabled by this plan.

Example

{
  "current_period": {
    "end": 1417392000,
    "experiments": [
      "1",
      "2"
    ],
    "object": "plan_period",
    "start": 1414800000
  },
  "name": "SigOpt Premium",
  "object": "plan",
  "rules": {
    "max_categorical_breadth": 6,
    "max_checkpoints": 0,
    "max_clients": 1,
    "max_conditionals_breadth": 6,
    "max_constraints": 0,
    "max_dimension": 10,
    "max_experiments": 10,
    "max_extra_failures": null,
    "max_metrics": null,
    "max_num_search_metrics": 4,
    "max_observations": 150,
    "max_optimized_grid_length": 50,
    "max_optimized_runs": null,
    "max_parallelism": 6,
    "max_solutions": 0,
    "max_storage_bytes": 0,
    "max_users": null,
    "object": "plan_rules",
    "plan_tier": 0,
    "supports_benchmarking": false,
    "supports_multitask": true,
    "supports_saml": false,
    "warn_optimized_runs": null
  }
}