GET
/
api
/
{projectId}
/
optimize
/
config
Get config
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/config \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "name": "<string>",
  "targetLatency": 0,
  "targetDevice": {
    "name": "cortex-m4f-80mhz",
    "ram": 1024,
    "rom": 1024
  },
  "compiler": [
    "<string>"
  ],
  "precision": [
    "<string>"
  ],
  "trainingCycles": 5,
  "tuningMaxTrials": 2,
  "tuningWorkers": 1,
  "initialTrials": 5,
  "optimizationRounds": 3,
  "trialsPerOptimizationRound": 3,
  "minMACCS": 123,
  "maxMACCS": 123,
  "tuningAlgorithm": "random",
  "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>",
  "optimizationPrecision": "float32",
  "earlyStopping": true,
  "earlyStoppingWindowSize": 123,
  "earlyStoppingImprovementBar": 123,
  "MOMF": true,
  "verboseLogging": true,
  "disableConstraints": true,
  "disableDeduplicate": true,
  "maxTotalTrainingTime": 123,
  "tunerSpaceOptions": {},
  "space": [
    {
      "parameters": {},
      "inputBlocks": [
        {}
      ],
      "dspBlocks": [
        {}
      ],
      "learnBlocks": [
        [
          {}
        ]
      ]
    }
  ],
  "searchSpaceTemplate": {
    "identifier": "speech_keyword",
    "classification": true,
    "anomaly": true,
    "regression": true
  },
  "searchSpaceSource": {
    "type": "template",
    "templateTitle": "<string>",
    "runTitle": "<string>",
    "impulseTitle": "<string>"
  },
  "device": {}
}

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
integer
required

Project ID

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

targetLatency
integer
required

Target latency in MS

Example:

0

targetDevice
object
required

Target device

error
string

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

name
string
compiler
string[]
precision
string[]
trainingCycles
integer

Maximum number of training cycles

Example:

5

tuningMaxTrials
integer

Maximum number of trials

Example:

2

tuningWorkers
integer

Maximum number of parallel workers/jobs

Example:

1

initialTrials
integer

Number of initial trials

Example:

5

optimizationRounds
integer

Number of optimization rounds

Example:

3

trialsPerOptimizationRound
integer

Number of trials per optimization round

Example:

3

minMACCS
number
maxMACCS
number
tuningAlgorithm
enum<string>

Tuning algorithm to use to search hyperparameter space

Available options:
random,
hyperband,
bayesian,
custom
notificationOnCompletion
boolean
importProjectMetrics
boolean

Whether to import metrics for previous EON tuner runs in the same project to accelerate the hyperparameter search process

importResourceMetrics
boolean

Whether to import resource usage (RAM/ROM/latency) metrics to accelerate the hyperparameter search process

numImportProjectMetrics
number

Number of project trials to import

numImportResourceMetrics
number

Number of resource usage trials to import

enableSEM
boolean

Enable standard error of the mean (SEM)

accuracySEM
number

Standard error of the trial accuracy mean

latencySEM
number

Standard error of the trial latency mean

optimizationObjectives
object[]

Hyperparameter optimization objectives and corresponding weights

rawObjectives
string

Hyperparameter optimization objectives + weights in string format

optimizationPrecision
enum<string>

Model variant to optimize for

Available options:
float32,
int8
earlyStopping
boolean

Enable trial level early stopping based on loss metrics during training

earlyStoppingWindowSize
number

Stops the EON tuner if the feasible (mean) objective has not improved over the past “window_size” iterations

earlyStoppingImprovementBar
number

Threshold (in [0,1]) for considering relative improvement over the best point.

MOMF
boolean

Enable Multi-fidelity Multi-Objective optimization

verboseLogging
boolean

Enable verbose logging

disableConstraints
boolean

Disable search constraints

disableDeduplicate
boolean

Disable trial deduplication

maxTotalTrainingTime
number

Maximum total training time in seconds

tunerSpaceOptions
object
space
object[]

List of impulses specifying the EON Tuner search space

searchSpaceTemplate
object

Search space template

searchSpaceSource
object

Search space source

device
object