Documentation

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

Training Run Create

https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/training_runs

Only relevant for a Training Monitor experiment. Creates a new guest Training Run, given a suggestion.

Request Method: POST

Parameters

NameTypeRequired?Description
suggestionstringYThe id of the Suggestion to which this Training Run is associated.
metadataMetadataNOptional user-provided object. See Using Metadata for more information.

Response

Training Run object.

Example Request

training_run = conn.experiments(EXPERIMENT_ID).training_runs().create(
  suggestion="42009"
  )
Response
{
  "created": 1554842896,
  "id": "19147",
  "object": "training_run",
  "observation": "58777",
  "suggestion": "42009",
  "updated": 1554842896
}