Archived Documentation

Welcome to the developer documentation for SigOpt. If you have a question you can’t answer, feel free to contact us!
You are currently viewing archived SigOpt documentation. The newest documentation can be found here.

Parameter Constraint Object

A constraint on the eligible parameter values for your experiment. Parameters with constraints will only suggest assignments that obey the specified constraints. See Parameter constraints for more information.

Fields

KeyTypeValue
termsarray<Constraint Term>The terms that make up this constraint.
thresholdfloatThe threshold for this constraint. The experiment will only suggest parameters for which the weighted sum of all the terms exceeds (or is inferior, depending on the type of constraint) this threshold.
typestringThe type of constraint. It can be greater_than or less_than.

Example

{
  "terms": [
    {
      "name": "a",
      "weight": 1
    },
    {
      "name": "b",
      "weight": -1
    }
  ],
  "threshold": 0,
  "type": "greater_than"
}