Links

Observation List

https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/observations
Retrieves a Pagination of all Observation objects for this experiment. Observations are sorted in by IDs in descending order (so the newest observations are first).
Request Method: GET

Parameters

Name
Type
Required?
Description
after
string
N
Optional. Returns items with ids after after.
before
string
N
Optional. Returns items with ids before before.
limit
int
N
Optional. Limit the number of items returned. The maximum value is 100

Response

Pagination object.

Examples

Basic Observation List Request

Python
Bash
Java
observations = conn.experiments(EXPERIMENT_ID).observations().fetch()
OBSERVATIONS=`curl -s -X GET https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/observations -u "$SIGOPT_API_TOKEN":`
Pagination<Observation> observations = new Experiment(EXPERIMENT_ID).observations().list().call();
Response
{
"count": 3,
"data": [
{
"assignments": {
"degree": 2,
"gamma": 3.6,
"kernel": "rbf"
},
"created": 1414800000,
"experiment": "1",
"failed": true,
"id": "3",
"metadata": null,
"object": "observation",
"suggestion": "2",
"value": null,
"value_stddev": null,
"values": []
},
{
"assignments": {
"degree": 2,
"gamma": 3.6,
"kernel": "rbf"
},
"created": 1414800000,
"experiment": "1",
"failed": false,
"id": "2",
"metadata": {
"estimated_training_time_s": 302
},
"object": "observation",
"suggestion": "1",
"value": 1,
"value_stddev": 0.1,
"values": [
{
"name": "Accuracy",
"object": "metric_evaluation",
"value": 1,
"value_stddev": 0.1
}
]
},
{
"assignments": {
"degree": 2,
"gamma": 3.6,
"kernel": "rbf"
},
"created": 1414800000,
"experiment": "1",
"failed": false,
"id": "1",
"metadata": null,
"object": "observation",
"suggestion": "1",
"value": 1,
"value_stddev": null,
"values": [
{
"name": "Accuracy",
"object": "metric_evaluation",
"value": 1,
"value_stddev": null
}
]
}
],
"object": "pagination",
"paging": {
"after": "CgIQAw",
"before": null
}
}

Observation List Request with Limit

Python
Bash
Java
observations = conn.experiments(EXPERIMENT_ID).observations().fetch(
limit=1
)
OBSERVATIONS=`curl -s -X -G GET https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/observations -u "$SIGOPT_API_TOKEN": -d limit=1`
Pagination<Observation> observations = new Experiment(EXPERIMENT_ID).observations().list()
.addParam("limit", 1)
.call();
Response
{
"count": 3,
"data": [
{
"assignments": {
"degree": 2,
"gamma": 3.6,
"kernel": "rbf"
},
"created": 1414800000,
"experiment": "1",
"failed": true,
"id": "3",
"metadata": null,
"object": "observation",
"suggestion": "2",
"value": null,
"value_stddev": null,
"values": []
}
],
"object": "pagination",
"paging": {
"after": "CgIQAw",
"before": "CgIQAw"
}
}