Retrieves the EON tuner state

Retrieves the EON tuner state

Retrieves the EON tuner state

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/optimize/state

Path parameters

projectId*integer

Project ID

Response

200

Current EON tuner state

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

config*OptimizeConfig (object)

status*object

tunerJobIdinteger

Actual tuner process, job message events will be tagged with this ID

tunerCoordinatorJobIdinteger

The coordinator pod, attach the job runner to this process for finished events

tunerJobIsRunning*boolean

Whether the job is active (if false => finished)

trials*array of TunerTrial (object)

projectDataType*enum

audioimagemotionother

jobErrorstring

workers*array of object

nextRunIndex*integer

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "config": {
    "name": "text",
    "datasetCategory": "speech_keyword",
    "classificationType": "classification",
    "targetDevice": {
      "name": "cortex-m4f-80mhz",
      "ram": 1024,
      "rom": 1024
    },
    "compiler": [
      "text"
    ],
    "precision": [
      "text"
    ],
    "trainingCycles": 5,
    "tuningMaxTrials": 2,
    "tuningWorkers": 1,
    "minMACCS": 0,
    "maxMACCS": 0,
    "tuningAlgorithm": "random",
    "notificationOnCompletion": false,
    "space": [
      {
        "inputBlocks": [],
        "dspBlocks": [],
        "learnBlocks": []
      }
    ]
  },
  "status": {
    "status": "creating"
  },
  "tunerJobIsRunning": false,
  "trials": [
    {
      "id": "text",
      "status": "pending",
      "lastCompletedEpoch": "2024-07-04T18:33:51.243Z",
      "lastCompletedTraining": "2024-07-04T18:33:51.243Z",
      "workerId": "text",
      "blocks": [
        {
          "lastActive": "2024-07-04T18:33:51.243Z",
          "status": "pending",
          "type": "input"
        }
      ],
      "impulse": {
        "inputBlocks": [],
        "dspBlocks": [],
        "learnBlocks": []
      },
      "experiment": "text",
      "original_trial_id": "text",
      "dspJobId": {
        "training": 0,
        "testing": 0
      },
      "learnJobId": 0
    }
  ],
  "projectDataType": "audio",
  "jobError": "text",
  "workers": [
    {
      "workerId": "text",
      "status": "pending"
    }
  ]
}