Observation Update

https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/observations/OBSERVATION_ID

Updates an existing Observation.

Request Method: PUT

Parameters

NameTypeRequired?Description
assignmentsAssignmentsNProvide suggestion or assignments. Only provide if you want to manually specify values that the parameters held during this trial.
failedbooleanNA boolean indicating whether this observation failed for some reason. SigOpt takes this into consideration when optimizing. It is invalid for both failed to be true, and value to be present. The default value is false.
metadataMetadataNOptional user-provided object. See Using Metadata for more information.
suggestionstringNProvide suggestion or assignments. The id of the Suggestion you are reporting on.
valuefloatNThe observed metric value from this trial.
value_stddevfloatNThe standard deviation in value that was observed in this trial.

Response

Observation object.

Example Request

observation = conn.experiments(EXPERIMENT_ID).observations(OBSERVATION_ID).update(
  value_stddev=0.1
  )
Response
{
  "assignments": {
    "degree": 2,
    "gamma": 3.6,
    "kernel": "rbf"
  },
  "created": 1560895206,
  "experiment": "1",
  "failed": false,
  "id": "1",
  "metadata": null,
  "object": "observation",
  "suggestion": "1",
  "value": 1,
  "value_stddev": 0.1,
  "values": [
    {
      "name": "Accuracy",
      "object": "metric_evaluation",
      "value": 1,
      "value_stddev": 0.1
    }
  ]
}