Retrieves EON tuner state for a run.

Retrieves the EON tuner state for a specific run.

GET /api/{projectId}/optimize/{tunerCoordinatorJobId}/state

Retrieves EON tuner state for a run.

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/{tunerCoordinatorJobId}/state \
  --header 'x-api-key: <api-key>'

import requests

url = "https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/{tunerCoordinatorJobId}/state"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/{tunerCoordinatorJobId}/state', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/{tunerCoordinatorJobId}/state",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/{tunerCoordinatorJobId}/state"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/{tunerCoordinatorJobId}/state")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/{tunerCoordinatorJobId}/state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "config": {
    "targetLatency": 0,
    "targetDevice": {
      "name": "cortex-m4f-80mhz",
      "ram": 1024,
      "rom": 1024
    },
    "name": "<string>",
    "compiler": [
      "<string>"
    ],
    "precision": [
      "<string>"
    ],
    "trainingCycles": 5,
    "tuningMaxTrials": 2,
    "tuningWorkers": 1,
    "initialTrials": 5,
    "optimizationRounds": 3,
    "trialsPerOptimizationRound": 3,
    "minMACCS": 123,
    "maxMACCS": 123,
    "notificationOnCompletion": true,
    "importProjectMetrics": true,
    "importResourceMetrics": true,
    "numImportProjectMetrics": 123,
    "numImportResourceMetrics": 123,
    "enableSEM": true,
    "accuracySEM": 123,
    "latencySEM": 123,
    "optimizationObjectives": [
      {
        "objective": "<string>",
        "label": "<string>",
        "weight": 123
      }
    ],
    "rawObjectives": "<string>",
    "earlyStopping": true,
    "earlyStoppingWindowSize": 123,
    "earlyStoppingImprovementBar": 123,
    "MOMF": true,
    "verboseLogging": true,
    "disableConstraints": true,
    "disableDeduplicate": true,
    "maxTotalTrainingTime": 123,
    "tunerChildJobMemoryMiB": 32768,
    "tunerSpaceOptions": {},
    "space": [
      {
        "inputBlocks": [
          {}
        ],
        "dspBlocks": [
          {}
        ],
        "learnBlocks": [
          [
            {}
          ]
        ],
        "parameters": {}
      }
    ],
    "searchSpaceTemplate": {
      "classification": true,
      "anomaly": true,
      "regression": true
    },
    "searchSpaceSource": {
      "templateTitle": "<string>",
      "runTitle": "<string>",
      "impulseTitle": "<string>"
    }
  },
  "status": {
    "numPendingTrials": 123,
    "numRunningTrials": 123,
    "numCompletedTrials": 123,
    "numFailedTrials": 123,
    "numReadyWorkers": 123,
    "numBusyWorkers": 123,
    "numPendingWorkers": 123
  },
  "tunerJobIsRunning": true,
  "trials": [
    {
      "id": "<string>",
      "name": "<string>",
      "blocks": [
        {
          "id": 123,
          "retries": 123,
          "lastActive": "2023-11-07T05:31:56Z",
          "modelBlockIndex": 123
        }
      ],
      "impulse": {
        "inputBlocks": [
          {}
        ],
        "dspBlocks": [
          {}
        ],
        "learnBlocks": [
          {}
        ]
      },
      "lastCompletedEpoch": "2023-11-07T05:31:56Z",
      "lastCompletedTraining": "2023-11-07T05:31:56Z",
      "retries": 123,
      "currentEpoch": 123,
      "workerId": "<string>",
      "experiment": "<string>",
      "original_trial_id": "<string>",
      "model": {},
      "dspJobId": {
        "training": 123,
        "testing": 123
      },
      "learnJobId": 123,
      "devicePerformance": {},
      "optimizationRound": 123,
      "progress": {
        "epoch": 123,
        "loss": 123,
        "val_loss": 123,
        "accuracy": 123,
        "val_accuracy": 123
      },
      "metrics": {
        "test": {
          "float32": {
            "loss": 123,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "report": {},
            "onDevicePerformance": [
              {
                "mcu": "<string>",
                "name": "<string>",
                "isDefault": true,
                "latency": 123,
                "tflite": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "eon": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "hasPerformance": true,
                "eon_ram_optimized": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "customMetrics": [
                  {
                    "name": "<string>",
                    "value": "<string>"
                  }
                ],
                "profilingError": "<string>"
              }
            ],
            "isSupportedOnMcu": true,
            "additionalMetrics": [
              {
                "name": "<string>",
                "value": "<string>",
                "fullPrecisionValue": 123,
                "tooltipText": "<string>",
                "link": "<string>"
              }
            ],
            "accuracy": 123,
            "predictions": [
              {
                "sampleId": 123,
                "startMs": 123,
                "endMs": 123,
                "prediction": "<string>",
                "label": "<string>",
                "predictionCorrect": true,
                "f1Score": 123,
                "anomalyScores": [
                  [
                    123
                  ]
                ],
                "boundingBoxes": [
                  {
                    "label": "<string>",
                    "x": 123,
                    "y": 123,
                    "width": 123,
                    "height": 123,
                    "score": 123
                  }
                ],
                "labelMapPredictions": {}
              }
            ],
            "mcuSupportError": "<string>",
            "profilingJobId": 123,
            "profilingJobFailed": true
          },
          "int8": {
            "loss": 123,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "report": {},
            "onDevicePerformance": [
              {
                "mcu": "<string>",
                "name": "<string>",
                "isDefault": true,
                "latency": 123,
                "tflite": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "eon": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "hasPerformance": true,
                "eon_ram_optimized": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "customMetrics": [
                  {
                    "name": "<string>",
                    "value": "<string>"
                  }
                ],
                "profilingError": "<string>"
              }
            ],
            "isSupportedOnMcu": true,
            "additionalMetrics": [
              {
                "name": "<string>",
                "value": "<string>",
                "fullPrecisionValue": 123,
                "tooltipText": "<string>",
                "link": "<string>"
              }
            ],
            "accuracy": 123,
            "predictions": [
              {
                "sampleId": 123,
                "startMs": 123,
                "endMs": 123,
                "prediction": "<string>",
                "label": "<string>",
                "predictionCorrect": true,
                "f1Score": 123,
                "anomalyScores": [
                  [
                    123
                  ]
                ],
                "boundingBoxes": [
                  {
                    "label": "<string>",
                    "x": 123,
                    "y": 123,
                    "width": 123,
                    "height": 123,
                    "score": 123
                  }
                ],
                "labelMapPredictions": {}
              }
            ],
            "mcuSupportError": "<string>",
            "profilingJobId": 123,
            "profilingJobFailed": true
          }
        },
        "train": {
          "float32": {
            "loss": 123,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "report": {},
            "onDevicePerformance": [
              {
                "mcu": "<string>",
                "name": "<string>",
                "isDefault": true,
                "latency": 123,
                "tflite": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "eon": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "hasPerformance": true,
                "eon_ram_optimized": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "customMetrics": [
                  {
                    "name": "<string>",
                    "value": "<string>"
                  }
                ],
                "profilingError": "<string>"
              }
            ],
            "isSupportedOnMcu": true,
            "additionalMetrics": [
              {
                "name": "<string>",
                "value": "<string>",
                "fullPrecisionValue": 123,
                "tooltipText": "<string>",
                "link": "<string>"
              }
            ],
            "accuracy": 123,
            "predictions": [
              {
                "sampleId": 123,
                "startMs": 123,
                "endMs": 123,
                "prediction": "<string>",
                "label": "<string>",
                "predictionCorrect": true,
                "f1Score": 123,
                "anomalyScores": [
                  [
                    123
                  ]
                ],
                "boundingBoxes": [
                  {
                    "label": "<string>",
                    "x": 123,
                    "y": 123,
                    "width": 123,
                    "height": 123,
                    "score": 123
                  }
                ],
                "labelMapPredictions": {}
              }
            ],
            "mcuSupportError": "<string>",
            "profilingJobId": 123,
            "profilingJobFailed": true
          },
          "int8": {
            "loss": 123,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "report": {},
            "onDevicePerformance": [
              {
                "mcu": "<string>",
                "name": "<string>",
                "isDefault": true,
                "latency": 123,
                "tflite": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "eon": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "hasPerformance": true,
                "eon_ram_optimized": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "customMetrics": [
                  {
                    "name": "<string>",
                    "value": "<string>"
                  }
                ],
                "profilingError": "<string>"
              }
            ],
            "isSupportedOnMcu": true,
            "additionalMetrics": [
              {
                "name": "<string>",
                "value": "<string>",
                "fullPrecisionValue": 123,
                "tooltipText": "<string>",
                "link": "<string>"
              }
            ],
            "accuracy": 123,
            "predictions": [
              {
                "sampleId": 123,
                "startMs": 123,
                "endMs": 123,
                "prediction": "<string>",
                "label": "<string>",
                "predictionCorrect": true,
                "f1Score": 123,
                "anomalyScores": [
                  [
                    123
                  ]
                ],
                "boundingBoxes": [
                  {
                    "label": "<string>",
                    "x": 123,
                    "y": 123,
                    "width": 123,
                    "height": 123,
                    "score": 123
                  }
                ],
                "labelMapPredictions": {}
              }
            ],
            "mcuSupportError": "<string>",
            "profilingJobId": 123,
            "profilingJobFailed": true
          }
        },
        "validation": {
          "float32": {
            "loss": 123,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "report": {},
            "onDevicePerformance": [
              {
                "mcu": "<string>",
                "name": "<string>",
                "isDefault": true,
                "latency": 123,
                "tflite": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "eon": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "hasPerformance": true,
                "eon_ram_optimized": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "customMetrics": [
                  {
                    "name": "<string>",
                    "value": "<string>"
                  }
                ],
                "profilingError": "<string>"
              }
            ],
            "isSupportedOnMcu": true,
            "additionalMetrics": [
              {
                "name": "<string>",
                "value": "<string>",
                "fullPrecisionValue": 123,
                "tooltipText": "<string>",
                "link": "<string>"
              }
            ],
            "accuracy": 123,
            "predictions": [
              {
                "sampleId": 123,
                "startMs": 123,
                "endMs": 123,
                "prediction": "<string>",
                "label": "<string>",
                "predictionCorrect": true,
                "f1Score": 123,
                "anomalyScores": [
                  [
                    123
                  ]
                ],
                "boundingBoxes": [
                  {
                    "label": "<string>",
                    "x": 123,
                    "y": 123,
                    "width": 123,
                    "height": 123,
                    "score": 123
                  }
                ],
                "labelMapPredictions": {}
              }
            ],
            "mcuSupportError": "<string>",
            "profilingJobId": 123,
            "profilingJobFailed": true
          },
          "int8": {
            "loss": 123,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "report": {},
            "onDevicePerformance": [
              {
                "mcu": "<string>",
                "name": "<string>",
                "isDefault": true,
                "latency": 123,
                "tflite": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "eon": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "hasPerformance": true,
                "eon_ram_optimized": {
                  "ramRequired": 123,
                  "romRequired": 123,
                  "arenaSize": 123,
                  "modelSize": 123
                },
                "customMetrics": [
                  {
                    "name": "<string>",
                    "value": "<string>"
                  }
                ],
                "profilingError": "<string>"
              }
            ],
            "isSupportedOnMcu": true,
            "additionalMetrics": [
              {
                "name": "<string>",
                "value": "<string>",
                "fullPrecisionValue": 123,
                "tooltipText": "<string>",
                "link": "<string>"
              }
            ],
            "accuracy": 123,
            "predictions": [
              {
                "sampleId": 123,
                "startMs": 123,
                "endMs": 123,
                "prediction": "<string>",
                "label": "<string>",
                "predictionCorrect": true,
                "f1Score": 123,
                "anomalyScores": [
                  [
                    123
                  ]
                ],
                "boundingBoxes": [
                  {
                    "label": "<string>",
                    "x": 123,
                    "y": 123,
                    "width": 123,
                    "height": 123,
                    "score": 123
                  }
                ],
                "labelMapPredictions": {}
              }
            ],
            "mcuSupportError": "<string>",
            "profilingJobId": 123,
            "profilingJobFailed": true
          }
        }
      },
      "impulseAddedToProject": {
        "impulseId": 123,
        "link": "<string>"
      },
      "createdInPostProcessing": true
    }
  ],
  "workers": [
    {
      "workerId": "<string>"
    }
  ],
  "nextRunIndex": 123,
  "canExtendSearch": true,
  "isWhitelabel": true,
  "totalTrainingTimeExceeded": true,
  "error": "<string>",
  "tunerJobId": 123,
  "tunerCoordinatorJobId": 123,
  "continuationJobId": 123,
  "jobError": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

tunerCoordinatorJobId · integer · required

Tuner coordinator job ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

config · object · required

Show child attributes

status · object · required

Show child attributes

tunerJobIsRunning · boolean · required

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

trials · object[] · required

Show child attributes

projectDataType · enum<string> · required

Available options: audio, image, motion, other

workers · object[] · required

Show child attributes

nextRunIndex · integer · required

Index of the next run to be created. Used to pre-populate the name of the next run.

canExtendSearch · boolean · required

Whether the search can be extended to evaluate more candidate models. Extending is possible if the search space contains candidate models that are expected to perform better than the current best candidate. And extending is also possible if the previous run was paused due to the total runtime limit being exceeded.

isWhitelabel · boolean · required

totalTrainingTimeExceeded · boolean · required

Whether the total training time has exceeded the defined limit for the current run.

error · string

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

tunerJobId · integer

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

tunerCoordinatorJobId · integer

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

continuationJobId · integer

Job ID for the initial job this job continuous the hyperparameter search process for.

tuningAlgorithm · enum<string>

Tuning algorithm to use to search hyperparameter space

Available options: random, hyperband, bayesian, custom

jobError · string