Optimization

Retrieves the EON tuner state

Retrieves the EON tuner state

get/api/{projectId}/optimize/state

Request

Path parameters

projectIdinteger required

Project ID

Response

Current EON tuner state

successboolean required

Whether the operation succeeded

errorstring

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

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.

tuningAlgorithm'random' | 'hyperband' | 'bayesian' | 'custom'

Tuning algorithm to use to search hyperparameter space

tunerJobIsRunningboolean required

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

projectDataType'audio' | 'image' | 'motion' | 'other' required
jobErrorstring
nextRunIndexinteger required

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

canExtendSearchboolean 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.

isWhitelabelboolean required
totalTrainingTimeExceededboolean required

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

Example response

{
  "config": {
    "targetDevice": {
      "name": "cortex-m4f-80mhz",
      "ram": 1024,
      "rom": 1024
    },
    "trainingCycles": 5,
    "tuningMaxTrials": 2,
    "tuningWorkers": 1,
    "initialTrials": 5,
    "optimizationRounds": 3,
    "trialsPerOptimizationRound": 3
  },
  "trials": [
    {
      "metrics": {
        "test": {
          "float32": {
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ]
          },
          "int8": {
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ]
          }
        },
        "train": {
          "float32": {
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ]
          },
          "int8": {
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ]
          }
        },
        "validation": {
          "float32": {
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ]
          },
          "int8": {
            "confusionMatrix": [
              [
                31,
                1,
                0
              ],
              [
                2,
                27,
                3
              ],
              [
                1,
                0,
                39
              ]
            ]
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.