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 |
|---|---|---|
client | string | The id of the Client who created this experiment. |
conditionals | array<Conditional> | See conditionals. |
created | int | The timestamp (in seconds since epoch) that this experiment was created. |
id | string | A unique ID for this experiment. |
linear_constraints | array<Parameter Constraint> | See constraints. |
metadata | Metadata | Optional user-provided object. See Using Metadata for more information. |
metrics | array<Metric> | 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. |
name | string | A user-specified name for this experiment. |
num_solutions | int | The number of solutions you want for your experiment. The default number of solutions is 1. You can have up to 3 solutions. An observation budget is required if the number of solutions is greater than 1. |
observation_budget | int | The 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. |
parallel_bandwidth | int | 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. |
parameters | array<Parameter> | An array of Parameter objects. |
progress | Progress | The current progress of this experiment. |
project | string | The id of the project that this experiment belongs to. |
state | string | The state of this experiment. Can be active (for experiments that are currently running), or deleted (for experiments that have been deleted). |
type | string | A type for this experiment. Used for experimental and alpha features only. |
updated | int | The timestamp (in seconds since epoch) that this experiment was last updated. |
user | string | The id of the user who created this experiment. |
Deprecated Fields
These fields should no longer be used because there are better alternatives.
Supported Endpoints
| Method | URI | Description |
|---|---|---|
POST | /experiments | Experiment Create |
GET | /experiments/EXPERIMENT_ID | Experiment Detail |
GET | /experiments | Experiment List |
GET | /experiments/EXPERIMENT_ID/best_assignments | Experiment Best Assignments |
GET | /experiments/EXPERIMENT_ID/metric_importances | Experiment Metric Importances |
GET | /experiments/EXPERIMENT_ID/stopping_criteria | Experiment Stopping Criteria |
PUT | /experiments/EXPERIMENT_ID | Experiment Update |
DELETE | /experiments/EXPERIMENT_ID | Experiment Delete |
Example
{
"client": "1",
"created": 1414800000,
"development": false,
"id": "1",
"metadata": null,
"metric": {
"name": "Accuracy",
"object": "metric",
"objective": "maximize",
"strategy": "optimize",
"threshold": null
},
"metrics": [
{
"name": "Accuracy",
"object": "metric",
"objective": "maximize",
"strategy": "optimize",
"threshold": null
}
],
"name": "Support Vector Classifier Accuracy",
"num_solutions": null,
"object": "experiment",
"observation_budget": 60,
"parallel_bandwidth": null,
"parameters": [
{
"bounds": {
"max": 5,
"min": 1,
"object": "bounds"
},
"categorical_values": null,
"conditions": {},
"default_value": null,
"name": "degree",
"object": "parameter",
"precision": null,
"prior": null,
"transformation": null,
"tunable": true,
"type": "int"
},
{
"bounds": {
"max": 1,
"min": 0.001,
"object": "bounds"
},
"categorical_values": null,
"conditions": {},
"default_value": null,
"name": "gamma",
"object": "parameter",
"precision": null,
"prior": null,
"transformation": null,
"tunable": true,
"type": "double"
},
{
"bounds": null,
"categorical_values": [
{
"enum_index": 1,
"name": "rbf",
"object": "categorical_value"
},
{
"enum_index": 2,
"name": "poly",
"object": "categorical_value"
},
{
"enum_index": 3,
"name": "sigmoid",
"object": "categorical_value"
}
],
"conditions": {},
"default_value": null,
"name": "kernel",
"object": "parameter",
"precision": null,
"prior": null,
"transformation": null,
"tunable": true,
"type": "categorical"
}
],
"progress": {
"best_observation": null,
"first_observation": null,
"last_observation": null,
"object": "progress",
"observation_budget_consumed": 0,
"observation_count": 0
},
"project": "classification-models",
"state": "active",
"type": "offline",
"updated": 1446422400,
"user": null
}