Experiment Object
/experiments/EXPERIMENT_ID
An experiment represents an objective that SigOpt is optimizing, the relevant parameters, and the underlying data.
Fields
Key | Type | Value |
---|---|---|
|
| The id of the Client who created the SigOpt Experiment. |
|
| See conditionals. |
|
| The timestamp (in seconds since epoch) that this experiment was created. |
|
| A unique ID for a given experiment. |
|
| |
| Optional user-provided metadata. | |
|
| An array of Metric objects to be optimized or stored for analysis. Use only a single entry for the standard single criterion optimization problem. This array can have no more than 2 entries marked for optimization and no more than 50 entries in total. See Define and Set up Metric Space for more information. |
|
| A user-specified name for this experiment. |
|
| The number of solutions you want for your experiment. The default number of solutions is 1. See Multisolution for more information. |
|
| SeThe number of Observations you plan to create for this experiment. We recommend this value be between 10x and 20x the number of parameters. This can be thought of as a lower bound on the number of observations you will create. Failing to reach this value may result in suboptimal performance for your experiment. |
|
| The number of simultaneously open Suggestions you plan to maintain during this experiment. The default value for this is 1, i.e., a sequential experiment. The maximum value for this is dependent on your plan. This field is optional, but setting it correctly may improve performance. |
|
| An array of Parameter objects. |
| The current progress of this experiment. | |
|
| The state of this experiment. Can be |
|
| A type for this experiment. Used for random and grid. |
|
| The timestamp (in seconds since epoch) that this experiment was last updated. |
|
| The |
Deprecated Fields
These fields should no longer be used because there are better alternatives.
Supported Endpoints
Method | URI | Description |
---|---|---|
| Experiment Create | |
| Experiment Detail | |
| Experiment Best Assignments | |
| Experiment Metric Importances | |
| Experiment Stopping Criteria | |
| Experiment Update | |
| Experiment Delete |
Example
Last updated