Optimization

Get config

Get config

get/api/{projectId}/optimize/config

Request

Path parameters

projectIdinteger required

Project ID

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

namestring
targetLatencyinteger required

Target latency in MS

compilerstring[]
precisionstring[]
trainingCyclesinteger

Maximum number of training cycles

tuningMaxTrialsinteger

Maximum number of trials

tuningWorkersinteger

Maximum number of parallel workers/jobs

initialTrialsinteger

Number of initial trials

optimizationRoundsinteger

Number of optimization rounds

trialsPerOptimizationRoundinteger

Number of trials per optimization round

minMACCSnumber
maxMACCSnumber
tuningAlgorithm'random' | 'hyperband' | 'bayesian' | 'custom'

Tuning algorithm to use to search hyperparameter space

notificationOnCompletionboolean
importProjectMetricsboolean

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

importResourceMetricsboolean

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

numImportProjectMetricsnumber

Number of project trials to import

numImportResourceMetricsnumber

Number of resource usage trials to import

enableSEMboolean

Enable standard error of the mean (SEM)

accuracySEMnumber

Standard error of the trial accuracy mean

latencySEMnumber

Standard error of the trial latency mean

rawObjectivesstring

Hyperparameter optimization objectives + weights in string format

optimizationPrecision'float32' | 'int8'

Model variant to optimize for

earlyStoppingboolean

Enable trial level early stopping based on loss metrics during training

earlyStoppingWindowSizenumber

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

earlyStoppingImprovementBarnumber

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

MOMFboolean

Enable Multi-fidelity Multi-Objective optimization

verboseLoggingboolean

Enable verbose logging

disableConstraintsboolean

Disable search constraints

disableDeduplicateboolean

Disable trial deduplication

maxTotalTrainingTimenumber

Maximum total training time in seconds

tunerChildJobMemoryMiBinteger

Optional memory override for tuner child jobs (MiB), capped at 65536 MiB.

tunerSpaceOptionsobject
deviceobject

Example response

{
  "targetDevice": {
    "name": "cortex-m4f-80mhz",
    "ram": 1024,
    "rom": 1024
  },
  "trainingCycles": 5,
  "tuningMaxTrials": 2,
  "tuningWorkers": 1,
  "initialTrials": 5,
  "optimizationRounds": 3,
  "trialsPerOptimizationRound": 3
}

Changes

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