Retrieves EON tuner state for a run.

Retrieves EON tuner state for a run.

Retrieves the EON tuner state for a specific run.

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

Path parameters

projectId*integer

Project ID

tunerCoordinatorJobId*integer

Tuner coordinator job ID

Response

200

OK

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

continuationJobIdinteger

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

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

isWhitelabel*boolean

Request

JavaScriptCurlPython

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

Response

200

{
  "success": false,
  "error": "text",
  "config": {
    "name": "text",
    "targetLatency": 0,
    "targetDevice": {
      "name": "cortex-m4f-80mhz",
      "ram": 1024,
      "rom": 1024
    },
    "compiler": [
      "text"
    ],
    "precision": [
      "text"
    ],
    "trainingCycles": 5,
    "tuningMaxTrials": 2,
    "tuningWorkers": 1,
    "initialTrials": 5,
    "optimizationRounds": 3,
    "trialsPerOptimizationRound": 3,
    "minMACCS": 0,
    "maxMACCS": 0,
    "tuningAlgorithm": "random",
    "notificationOnCompletion": false,
    "importProjectMetrics": false,
    "importResourceMetrics": false,
    "numImportProjectMetrics": 0,
    "numImportResourceMetrics": 0,
    "enableSEM": false,
    "accuracySEM": 0,
    "latencySEM": 0,
    "optimizationObjectives": [
      "text"
    ],
    "rawObjectives": "text",
    "optimizationPrecision": "float32",
    "earlyStopping": false,
    "earlyStoppingWindowSize": 0,
    "earlyStoppingImprovementBar": 0,
    "MOMF": false,
    "verboseLogging": false,
    "space": [
      {
        "inputBlocks": [],
        "dspBlocks": [],
        "learnBlocks": [
          []
        ]
      }
    ],
    "searchSpaceTemplate": {
      "identifier": "speech_keyword",
      "classification": false,
      "anomaly": false,
      "regression": false
    }
  },
  "status": {
    "status": "creating"
  },
  "tunerJobIsRunning": false,
  "trials": [
    {
      "id": "text",
      "name": "text",
      "status": "pending",
      "lastCompletedEpoch": "2024-11-21T08:37:30.538Z",
      "lastCompletedTraining": "2024-11-21T08:37:30.538Z",
      "workerId": "text",
      "blocks": [
        {
          "lastActive": "2024-11-21T08:37:30.538Z",
          "status": "pending",
          "type": "input"
        }
      ],
      "impulse": {
        "inputBlocks": [],
        "dspBlocks": [],
        "learnBlocks": []
      },
      "experiment": "text",
      "original_trial_id": "text",
      "dspJobId": {
        "training": 0,
        "testing": 0
      },
      "learnJobId": 0,
      "optimizationRound": 0,
      "progress": {
        "epoch": 0,
        "loss": 0,
        "val_loss": 0,
        "accuracy": 0,
        "val_accuracy": 0
      },
      "metrics": {
        "test": {
          "float32": {
            "type": "int8",
            "loss": 0,
            "accuracy": 0,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "onDevicePerformance": [
              {
                "mcu": "text",
                "name": "text",
                "isDefault": false,
                "latency": 0,
                "tflite": {},
                "eon": {},
                "eon_ram_optimized": {},
                "customMetrics": [
                  {
                    "name": "text",
                    "value": "text"
                  }
                ]
              }
            ],
            "predictions": [
              {
                "startMs": 0,
                "endMs": 0,
                "label": "text",
                "prediction": "text",
                "predictionCorrect": false,
                "f1Score": 0,
                "anomalyScores": [
                  [
                    0
                  ]
                ]
              }
            ],
            "visualization": "featureExplorer",
            "isSupportedOnMcu": false,
            "mcuSupportError": "text",
            "profilingJobFailed": false,
            "additionalMetrics": [
              {
                "name": "text",
                "value": "text",
                "fullPrecisionValue": 0,
                "tooltipText": "text",
                "link": "text"
              }
            ]
          },
          "int8": {
            "type": "int8",
            "loss": 0,
            "accuracy": 0,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "onDevicePerformance": [
              {
                "mcu": "text",
                "name": "text",
                "isDefault": false,
                "latency": 0,
                "tflite": {},
                "eon": {},
                "eon_ram_optimized": {},
                "customMetrics": [
                  {
                    "name": "text",
                    "value": "text"
                  }
                ]
              }
            ],
            "predictions": [
              {
                "startMs": 0,
                "endMs": 0,
                "label": "text",
                "prediction": "text",
                "predictionCorrect": false,
                "f1Score": 0,
                "anomalyScores": [
                  [
                    0
                  ]
                ]
              }
            ],
            "visualization": "featureExplorer",
            "isSupportedOnMcu": false,
            "mcuSupportError": "text",
            "profilingJobFailed": false,
            "additionalMetrics": [
              {
                "name": "text",
                "value": "text",
                "fullPrecisionValue": 0,
                "tooltipText": "text",
                "link": "text"
              }
            ]
          }
        },
        "train": {
          "float32": {
            "type": "int8",
            "loss": 0,
            "accuracy": 0,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "onDevicePerformance": [
              {
                "mcu": "text",
                "name": "text",
                "isDefault": false,
                "latency": 0,
                "tflite": {},
                "eon": {},
                "eon_ram_optimized": {},
                "customMetrics": [
                  {
                    "name": "text",
                    "value": "text"
                  }
                ]
              }
            ],
            "predictions": [
              {
                "startMs": 0,
                "endMs": 0,
                "label": "text",
                "prediction": "text",
                "predictionCorrect": false,
                "f1Score": 0,
                "anomalyScores": [
                  [
                    0
                  ]
                ]
              }
            ],
            "visualization": "featureExplorer",
            "isSupportedOnMcu": false,
            "mcuSupportError": "text",
            "profilingJobFailed": false,
            "additionalMetrics": [
              {
                "name": "text",
                "value": "text",
                "fullPrecisionValue": 0,
                "tooltipText": "text",
                "link": "text"
              }
            ]
          },
          "int8": {
            "type": "int8",
            "loss": 0,
            "accuracy": 0,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "onDevicePerformance": [
              {
                "mcu": "text",
                "name": "text",
                "isDefault": false,
                "latency": 0,
                "tflite": {},
                "eon": {},
                "eon_ram_optimized": {},
                "customMetrics": [
                  {
                    "name": "text",
                    "value": "text"
                  }
                ]
              }
            ],
            "predictions": [
              {
                "startMs": 0,
                "endMs": 0,
                "label": "text",
                "prediction": "text",
                "predictionCorrect": false,
                "f1Score": 0,
                "anomalyScores": [
                  [
                    0
                  ]
                ]
              }
            ],
            "visualization": "featureExplorer",
            "isSupportedOnMcu": false,
            "mcuSupportError": "text",
            "profilingJobFailed": false,
            "additionalMetrics": [
              {
                "name": "text",
                "value": "text",
                "fullPrecisionValue": 0,
                "tooltipText": "text",
                "link": "text"
              }
            ]
          }
        },
        "validation": {
          "float32": {
            "type": "int8",
            "loss": 0,
            "accuracy": 0,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "onDevicePerformance": [
              {
                "mcu": "text",
                "name": "text",
                "isDefault": false,
                "latency": 0,
                "tflite": {},
                "eon": {},
                "eon_ram_optimized": {},
                "customMetrics": [
                  {
                    "name": "text",
                    "value": "text"
                  }
                ]
              }
            ],
            "predictions": [
              {
                "startMs": 0,
                "endMs": 0,
                "label": "text",
                "prediction": "text",
                "predictionCorrect": false,
                "f1Score": 0,
                "anomalyScores": [
                  [
                    0
                  ]
                ]
              }
            ],
            "visualization": "featureExplorer",
            "isSupportedOnMcu": false,
            "mcuSupportError": "text",
            "profilingJobFailed": false,
            "additionalMetrics": [
              {
                "name": "text",
                "value": "text",
                "fullPrecisionValue": 0,
                "tooltipText": "text",
                "link": "text"
              }
            ]
          },
          "int8": {
            "type": "int8",
            "loss": 0,
            "accuracy": 0,
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ],
            "onDevicePerformance": [
              {
                "mcu": "text",
                "name": "text",
                "isDefault": false,
                "latency": 0,
                "tflite": {},
                "eon": {},
                "eon_ram_optimized": {},
                "customMetrics": [
                  {
                    "name": "text",
                    "value": "text"
                  }
                ]
              }
            ],
            "predictions": [
              {
                "startMs": 0,
                "endMs": 0,
                "label": "text",
                "prediction": "text",
                "predictionCorrect": false,
                "f1Score": 0,
                "anomalyScores": [
                  [
                    0
                  ]
                ]
              }
            ],
            "visualization": "featureExplorer",
            "isSupportedOnMcu": false,
            "mcuSupportError": "text",
            "profilingJobFailed": false,
            "additionalMetrics": [
              {
                "name": "text",
                "value": "text",
                "fullPrecisionValue": 0,
                "tooltipText": "text",
                "link": "text"
              }
            ]
          }
        }
      },
      "impulseAddedToProject": {
        "link": "text"
      }
    }
  ],
  "projectDataType": "audio",
  "jobError": "text",
  "workers": [
    {
      "workerId": "text",
      "status": "pending"
    }
  ],
  "isWhitelabel": false
}