LogoLogo
sigopt.comLog In / Sign Up
  • Welcome to SigOpt!
    • SigOpt API Modules
    • Main Concepts
      • Define and Set Up Parameter Space
      • Define and Set Up Metric Space
      • Alternative Experiment Types
  • Advanced Experimentation
    • Multimetric Optimization
    • Metric Thresholds
    • Metric Constraints
    • Metric Failure
    • All Constraints Experiment
    • Multisolution
    • Parallelism
    • Parameter Constraints
    • Prior Beliefs
    • Multitask Experiments
  • Core Module API References
    • Installation and Setup
    • Quick Start
    • API Topics
      • API Tokens and Authentication
      • API Errors
      • Manage Open Suggestions
      • Metadata
      • Pagination
    • API Endpoints
      • Client Detail
      • Experiment Best Assignments
      • Experiment Create
      • Experiment Delete
      • Experiment Detail
      • Experiment Metric Importances
      • Experiment Stopping Criteria
      • Experiment Update
      • Observation Create
      • Observation Batch Create
      • Observation Delete
      • Observation Detail
      • Observation List Delete
      • Observation List
      • Observation Update
      • Queued Suggestion Create
      • Queued Suggestion Delete
      • Queued Suggestion Detail
      • Queued Suggestion List
      • Suggestion Create
      • Suggestion Delete
      • Suggestion Detail
      • Suggestion List Delete
      • Suggestion List
      • Experiment Token Create
      • Organization Detail
      • Suggestion Update
    • API Objects
      • Assignments Object
      • Best Assignments Object
      • Bounds Object
      • Categorical Value Object
      • Client Object
      • Conditional Object
      • Conditions Object
      • Constraint Term Object
      • Experiment Object
      • Metadata Object
      • Metric Object
      • Metric Evaluation Object
      • Metric Importances Object
      • Observation Object
      • Organization Object
      • Pagination Object
      • Parameter Object
      • Parameter Constraint Object
      • Plan Object
      • Plan Period Object
      • Plan Rules Object
      • Prior Object
      • Progress Object
      • Queued Suggestion Object
      • Stopping Criteria Object
      • Suggestion Object
      • Token Object
  • AI MODULE API REFERENCES
    • Installation and Setup
    • Quick Start Tutorials
      • Run Tutorial
      • Project Tutorial
      • AI Experiment and Optimization Tutorial
    • Tracking Your Training Runs
      • Set Up for Example Code
      • Record SigOpt Runs in Jupyter
      • Record SigOpt Runs with Python IDE and SigOpt CLI
      • Record SigOpt Runs with Python IDE
      • View and Analyze the Recorded SigOpt Run
      • Enable Optimization for your SigOpt Runs
    • AI Experiments
      • AI Experiment Set Up
    • Bring Your Own Optimizer
    • XGBoost Integration
      • Installation
      • Tracking XGBoost Training
      • Tuning XGBoost Models
    • HyperOpt
      • Installation
      • User Case
      • API
    • SigOpt Orchestrate
      • Install SigOpt Orchestrate
      • Orchestrate a Tracked Training Run
      • Orchestrate an AI Experiment
      • AWS Cluster Create and Manage
      • SigOpt: Bring Your Own Cluster
      • Dockerfile: Define Your Environment
      • Debugging
      • CLI Reference
    • API Reference
      • Manually create a SigOpt Run
      • Tracking a Run
      • AI Experiment Client Calls
      • Project Client Calls
      • Objects
        • Training Run Object
        • AI Experiment Object
        • Parameter Object
        • Metric Object
      • SigOpt CLI Commands
      • Orchestrate CLI Commands
  • Support
    • Support
    • FAQ
    • Best Practices
      • Setting an experiment budget
      • Reproducibility in SigOpt
      • Uploading data as a Training Run artifact
      • Navigating multiple metrics
Powered by GitBook
On this page
  • Fields
  • Deprecated Fields
  • Supported Endpoints
  • Examples
  1. Core Module API References
  2. API Objects

Observation Object

/experiments/EXPERIMENT_ID/observations/OBSERVATION_ID

The observed data from a single trial in your experiment. Observations have a values which reflects the values of the metrics you are trying to optimize.

Fields

Key
Type
Value

assignments

created

int

The timestamp (in seconds since epoch) that this observation was reported.

experiment

string

failed

boolean

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 or values to be present. The default value is false.

id

string

A unique ID for this observation.

metadata

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

suggestion

string

values

Deprecated Fields

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

Key
Type
Value

value

float

The observed metric value from this trial. Only available for single metric experiments.

value_stddev

float

The standard deviation in value that was observed in this trial. Only available for single metric experiments.

Supported Endpoints

Method
URI
Description

POST

Observation Batch Create

POST

Observation Create

GET

Observation Detail

GET

Observation List

PUT

Observation Update

DELETE

Observation Delete

DELETE

Observation List Delete

Examples

{
  "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
    }
  ]
}
{
  "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
}
PreviousMetric Importances ObjectNextOrganization Object

Last updated 2 years ago

The values that the parameters held during this trial, usually set from a .

The id of the for this observation.

The id of the that provided the assignments for this observation.

array<>

An array of objects recording the values and other associated information for each metric in a given observation. This is available for both single metric and multimetric experiments. Values appear in alphabetical order by the metric name.

Assignments
Suggestion
Experiment
Metadata
Suggestion
Metric Evaluation
Metric Evaluation
/experiments/EXPERIMENT_ID/observations/batch
/experiments/EXPERIMENT_ID/observations
/experiments/EXPERIMENT_ID/observations/OBSERVATION_ID
/experiments/EXPERIMENT_ID/observations
/experiments/EXPERIMENT_ID/observations/OBSERVATION_ID
/experiments/EXPERIMENT_ID/observations/OBSERVATION_ID
/experiments/EXPERIMENT_ID/observations