Documentation

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

Checkpoint List

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

Only relevant for a Training Monitor experiment. Retrieves a Pagination of all Checkpoint objects for a given Training Run.

Request Method: GET

Parameters

This endpoint takes no parameters.

Response

Checkpoint object.

Example Request

training_runs = conn.experiments(EXPERIMENT_ID).training_runs(TRAINING_RUN_ID).checkpoints().fetch()
Response
{
  "count": 3,
  "data": [
    {
      "created": 1554842812,
      "id": "108468",
      "object": "checkpoint",
      "should_stop": false,
      "stopping_reasons": {
        "Look Back 2 Steps": false
      },
      "training_run": "19147",
      "values": [
        {
          "name": "Validation Accuracy",
          "object": "metric_evaluation",
          "value": 0.6543,
          "value_stddev": null
        }
      ]
    },
    {
      "created": 1554842937,
      "id": "108473",
      "object": "checkpoint",
      "should_stop": false,
      "stopping_reasons": {
        "Look Back 2 Steps": false
      },
      "training_run": "19147",
      "values": [
        {
          "name": "Validation Accuracy",
          "object": "metric_evaluation",
          "value": 0.7654,
          "value_stddev": null
        }
      ]
    },
    {
      "created": 1554843029,
      "id": "108489",
      "object": "checkpoint",
      "should_stop": true,
      "stopping_reasons": {
        "Look Back 2 Steps": true
      },
      "training_run": "19147",
      "values": [
        {
          "name": "Validation Accuracy",
          "object": "metric_evaluation",
          "value": 0.5432,
          "value_stddev": null
        }
      ]
    }
  ],
  "object": "pagination",
  "paging": {
    "after": "108468",
    "before": "108489"
  }
}