Documentation

Welcome to the developer documentation for SigOpt. If you have a question you can’t answer, feel free to contact us!
Welcome to the new SigOpt docs! If you're looking for the classic SigOpt documentation then you can find that here. Otherwise, happy optimizing!

Metric

A metric is a variable that can be tracked in association with a Run. In an HPO Experiment, a metric or set of metrics represents the performance of an associated parameter configuration.

KeyTypeValue
namestringA user-specified name for a given metric
objectivestringOptional. 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”.
strategystringOptional. 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 Using Metric Strategy for more details. Constraint metrics can be used to specify additional guardrail metrics. See Metric Constraints for more details.
thresholdfloatThe 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.