Documentation

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

Metric Importances Object

An object describing the relative importance of each parameter, corresponding to a specific metric. A Pagination of these objects is returned from the Metric Importances List endpoint.

This object behaves like a dictionary or mapping in most programming languages. Fields can be accessed using standard notation, such as obj['key'] in Python or obj.get('key') in Java.

Fields

KeyTypeValue
importancesobjectA mapping of each parameter to its relative importance for the corresponding metric.
metricstringThe corresponding metric name.

Example

{
  "importances": {
    "a": 0.92,
    "b": 0.65,
    "c": 0.03
  },
  "metric": "Accuracy",
  "object": "metric_importances"
}