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.

Stopping Criteria Object

Criteria by which an Experiment could be judged to be completed. If you are looking for guidance on whether you should stop or continue requesting more observations, Stopping Criteria can make recommendations.


reasonsarray<string>Any stopping criteria which have been satisfied. Possible reasons include:
You have reached the observation_budget for this experiment
No improvement has been observed for a while. We use a variety of techniques to predict if an experiment is stagnant - however these methods are only estimates and we are not able to provide a score for how likely you are to observe improvement beyond this point. For this reason, we recommend setting an explicit observation_budget.
should_stopbooleanWhether any stopping criteria have been satisfied. If this value is true, you could consider terminating your experiment.