Metric Object

A representation of the value that an experiment is optimizing.

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” or “store” If unspecified, the metric will be optimized. Stored metrics can be helpful for tracking and additional analysis. See Using Metric Strategy for more details.
thresholdfloatThe minimum or maximum desired value for your metric. See the thresholds documentation for more details. This field is currently only supported by experiments with more than one optimized metric and can only be specified on optimized metrics.

Example

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