Documentation

Welcome to SigOpt’s developer documentation. If you have a question you can’t answer, feel free to contact us!

Metric Object

A representation of the value that an experiment is optimizing, storing, or constraining.

Fields

KeyTypeValue
namestringA user-specified name for this metric.
objectivestringOptional. Specifies the direction of improvement for this metric. Can be “maximize” or “minimize”. If unspecified, the metric will be maximized.
strategystringOptional. Specifies how SigOpt will use this metric. Can be “optimize”, “store”, or “constraint”. If unspecified, the metric will be optimized. Stored metrics can be helpful for tracking and additional analysis. See Using Metric Strategy for more details. Constraint metrics can be used to specifiy additional guardrail metrics. See Constraint Metric for more details.
thresholdfloatThe minimum or maximum desired value for your metric. To apply thresholds on optimized metrics, see the thresholds documentation for more details. To apply thresholds on constraint metrics, see the constraint metric documentations for more details. This field must be defined when the strategy is set to constraint.

Example

{
  "name": "Accuracy",
  "object": "metric",
  "objective": "maximize",
  "strategy": "optimize",
  "threshold": null
}