Metric Object

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

Fields

Key	Type	Value
name	string	A user-specified name for a given metric
objective	string	Optional. Specifies the direction of improvement for a given metric. For any metric the objective can be to either “maximize” or “minimize”. If unspecified the default will be “maximize”.
strategy	string	Optional. Specifies how SigOpt will use a given metric. Can be “optimize”, “store”, or “constraints”. If unspecified, the metric will be optimized. Stored metrics can be helpful for tracking and additional analysis. See Define and Set Up Metric Space for more details.
threshold	float	The minimum or maximum desired value for a given metric. To apply thresholds on optimized metrics, see the Metric Thresholds documentation for more details. To apply thresholds on non optimized metrics, see the Metric Constraints documentation 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
}