Suggestion Create

https://api.sigopt.com/v1/experiments/EXPERIMENT_ID/suggestions

When you are ready to start working, create a Suggestion. The response object will contain the assignments that SigOpt recommends in order to optimize your metric.

Request Method: POST

Parameters

Name	Type	Required?	Description
`assignments`	`Assignments`	N	Allows you to specify the assignments of this suggestion. You must specify exactly one value for each parameter in the experiment.
`metadata`	`Metadata`	N	Optional user-provided object. See Using Metadata for more information.

Response

Suggestion object.

Examples

Create a suggestion
Create a manual suggestion with custom parameter values

suggestion = conn.experiments(EXPERIMENT_ID).suggestions().create()

Response

{
  "assignments": {
    "degree": 2,
    "gamma": 3.6,
    "kernel": "rbf"
  },
  "created": 1414800000,
  "deleted": null,
  "experiment": "1",
  "id": "1",
  "metadata": null,
  "object": "suggestion",
  "state": "open"
}

Create a manual suggestion with custom parameter values

Python
Java
suggestion = conn.experiments(EXPERIMENT_ID).suggestions().create(
  assignments=dict(
    degree=2,
    gamma=3.6,
    kernel="rbf"
    )
  )

Response

{
  "assignments": {
    "degree": 2,
    "gamma": 3.6,
    "kernel": "rbf"
  },
  "created": 1414800000,
  "deleted": null,
  "experiment": "1",
  "id": "1",
  "metadata": null,
  "object": "suggestion",
  "state": "open"
}

Documentation

Suggestion Create

Parameters

Response

Examples

Create a suggestion

Create a manual suggestion with custom parameter values

Related Endpoints