Documentation

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

Training Run List

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

Only relevant for a Training Monitor experiment. Retrieves a Pagination of all Training Run objects for a given experiment. A suggestion or observation can be specified to return only those Training Runs associated with that given suggestion or observation.

Request Method: GET

Parameters

NameTypeRequired?Description
observationstringNThe id of the Observation(s) to which this Training Run is associated. Only possible after Observation Create has been called with this Training Run. See this page for more information.
suggestionstringNThe id of the Suggestion(s) from which this Training Run was created.

Response

Training Run object.

Examples

Fetch a Training Run with a Suggestion

training_runs = conn.experiments(EXPERIMENT_ID).training_runs().fetch(
  suggestion="42009"
  )
Response
{
  "count": 1,
  "data": [
    {
      "created": 1554842896,
      "id": "19147",
      "object": "training_run",
      "observation": "58777",
      "suggestion": "42009",
      "updated": 1554842913
    }
  ],
  "object": "pagination",
  "paging": {
    "after": "19147",
    "before": "19147"
  }
}

Fetch a Training Run with an Observation

training_runs = conn.experiments(EXPERIMENT_ID).training_runs().fetch(
  observation="58777"
  )
Response
{
  "count": 1,
  "data": [
    {
      "created": 1554842896,
      "id": "19147",
      "object": "training_run",
      "observation": "58777",
      "suggestion": "42009",
      "updated": 1554842913
    }
  ],
  "object": "pagination",
  "paging": {
    "after": "19147",
    "before": "19147"
  }
}

Fetching all Training Runs

training_runs = conn.experiments(EXPERIMENT_ID).training_runs().fetch()
Response
{
  "count": 2,
  "data": [
    {
      "created": 1554842896,
      "id": "19147",
      "object": "training_run",
      "observation": "58777",
      "suggestion": "42009",
      "updated": 1554842913
    },
    {
      "created": 1554842922,
      "id": "19158",
      "object": "training_run",
      "observation": "58801",
      "suggestion": "42023",
      "updated": 1554842947
    }
  ],
  "object": "pagination",
  "paging": {
    "after": "19147",
    "before": "19158"
  }
}