Checkpoint Create
https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/training_runs/TRAINING_RUN_ID/checkpoints
Only relevant for a Training Monitor experiment. Creates a new guest Checkpoint for a given Training Run. Note that metadata for checkpoints can have no more than 4 entries.
Request Method: POST
Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
training_run | string | Y | The id of the Training Run to which this Checkpoint is associated. |
values | array<Metric Evaluation> | Y | An array of Metric Evaluation objects. For Training Monitor experiments, this is required even in single metric experiments. |
metadata | Metadata | N | Optional user-provided object. See Using Metadata for more information. |
Response
Training Run object.Example Request
Response
{
"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
}
]
}