Optimization

Retrieves EON tuner state for a run.

Retrieves the EON tuner state for a specific run.

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

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/optimize/:tunerCoordinatorJobId/state/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

tunerCoordinatorJobIdinteger required

Tuner coordinator job ID

Response

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.