Experiment List

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

Retrieves a Pagination of all Experiment objects for this client.

Request Method: GET

Parameters

NameTypeRequired?Description
afterstringNOptional. Returns items with ids after after.
beforestringNOptional. Returns items with ids before before.
limitintNOptional. Limit the number of items returned. The maximum value is 100.

Response

Pagination object.

Example Request

experiments = conn.experiments().fetch(
  before=3,
  limit=10
  )
Response
{
  "count": 3,
  "data": [
    {
      "client": "1",
      "conditionals": [],
      "created": 1565896954,
      "development": false,
      "id": "2",
      "linear_constraints": [],
      "metadata": null,
      "metric": {
        "name": "Accuracy",
        "object": "metric",
        "objective": "maximize",
        "threshold": null
      },
      "metrics": [
        {
          "name": "Accuracy",
          "object": "metric",
          "objective": "maximize",
          "threshold": null
        }
      ],
      "name": "Classifier Accuracy",
      "num_solutions": null,
      "object": "experiment",
      "observation_budget": 20,
      "parallel_bandwidth": 1,
      "parameters": [
        {
          "bounds": {
            "max": 1,
            "min": 0.001,
            "object": "bounds"
          },
          "categorical_values": null,
          "conditions": {},
          "default_value": null,
          "name": "gamma",
          "object": "parameter",
          "precision": null,
          "tunable": true,
          "type": "double"
        }
      ],
      "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": 1565896954,
      "user": null
    }
  ],
  "object": "pagination",
  "paging": {
    "after": "2",
    "before": "2"
  }
}