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

KeyTypeValue
current_periodPlan PeriodA description of the current time period for this plan.
idstringA unique identifier for this plan.
namestringA human-readable description of this plan.
rulesPlan RulesThe features enabled by this plan.

Example

{
  "current_period": {
    "end": 1570907564,
    "experiments": [
      "1",
      "2"
    ],
    "object": "plan_period",
    "start": 1568315564
  },
  "name": "SigOpt Premium",
  "object": "plan",
  "ongoing_rules": {
    "max_categorical_breadth": 6,
    "max_checkpoints": null,
    "max_clients": null,
    "max_conditionals_breadth": 3,
    "max_constraints": null,
    "max_dimension": 10,
    "max_experiments": 10,
    "max_extra_failures": null,
    "max_metrics": null,
    "max_observations": 150,
    "max_parallelism": 6,
    "max_solutions": null,
    "max_users": null,
    "object": "plan_rules",
    "soft_limits": null,
    "supports_benchmarking": null,
    "supports_multitask": null
  },
  "rules": {
    "max_categorical_breadth": 6,
    "max_checkpoints": null,
    "max_clients": null,
    "max_conditionals_breadth": 3,
    "max_constraints": null,
    "max_dimension": 10,
    "max_experiments": 10,
    "max_extra_failures": null,
    "max_metrics": null,
    "max_observations": 150,
    "max_parallelism": 6,
    "max_solutions": null,
    "max_users": null,
    "object": "plan_rules",
    "soft_limits": null,
    "supports_benchmarking": null,
    "supports_multitask": null
  },
  "trial_rules": {
    "max_categorical_breadth": null,
    "max_checkpoints": null,
    "max_clients": null,
    "max_conditionals_breadth": null,
    "max_constraints": null,
    "max_dimension": null,
    "max_experiments": null,
    "max_extra_failures": null,
    "max_metrics": null,
    "max_observations": null,
    "max_parallelism": null,
    "max_solutions": null,
    "max_users": null,
    "object": "plan_rules",
    "soft_limits": null,
    "supports_benchmarking": null,
    "supports_multitask": null
  }
}