Observation Update

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

Updates an existing Observation.

Request Method: PUT

Parameters

NameTypeRequired?Description

assignments

N

Provide suggestion or assignments. Only provide if you want to manually specify values that the parameters held during this trial.

failed

boolean

N

A 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.

metadata

N

Optional user-provided object. See Using Metadata for more information.

suggestion

string

N

values

N

Deprecated Parameters

These parameters should no longer be used because there are better alternatives.

NameTypeRequired?Description

value

float

N

The observed metric value from this trial.

value_stddev

float

N

The standard deviation in value that was observed in this trial.

Response

Observation object.

Example Request

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

Last updated