Update config

Update config

Update config

post

/api/{projectId}/optimize/config

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

Body

namestring

targetLatencyintegerrequired

Target latency in MS

Example: 0

trainingCyclesinteger

Maximum number of training cycles

Example: 5

tuningMaxTrialsinteger

Maximum number of trials

Example: 2

tuningWorkersinteger

Maximum number of parallel workers/jobs

Example: 1

initialTrialsinteger

Number of initial trials

Example: 5

optimizationRoundsinteger

Number of optimization rounds

Example: 3

trialsPerOptimizationRoundinteger

Number of trials per optimization round

Example: 3

minMACCSnumber

maxMACCSnumber

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

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

tuningAlgorithmstring · enum

Tuning algorithm to use to search hyperparameter space

Options: random, hyperband, bayesian, custom

optimizationPrecisionstring · enum

Model variant to optimize for

Options: float32, int8

compilerstring[]

precisionstring[]

spaceobject[]

List of impulses specifying the EON Tuner search space

targetDeviceobjectrequired

Target device

tunerSpaceOptionsobject

searchSpaceTemplateobject

Search space template

searchSpaceSourceobject

Search space source

optimizationObjectivesobject[]

Hyperparameter optimization objectives and corresponding weights

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/optimize/config' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"targetLatency":0,"trainingCycles":5,"tuningMaxTrials":2,"tuningWorkers":1,"initialTrials":5,"optimizationRounds":3,"trialsPerOptimizationRound":3,"tuningAlgorithm":"random","optimizationPrecision":"float32","compiler":[null],"precision":[null],"space":[{"parameters":{},"inputBlocks":[{"ANY_ADDITIONAL_PROPERTY":"anything"}],"dspBlocks":[{"ANY_ADDITIONAL_PROPERTY":"anything"}],"learnBlocks":[[{"ANY_ADDITIONAL_PROPERTY":"anything"}]]}],"targetDevice":{"name":"cortex-m4f-80mhz","ram":1024,"rom":1024},"tunerSpaceOptions":{"ANY_ADDITIONAL_PROPERTY":[null]},"searchSpaceTemplate":{"identifier":"speech_keyword"},"searchSpaceSource":{"type":"template"},"optimizationObjectives":[{"objective":"text","label":"text","weight":1}]}'

200

200

{
  "success": true,
  "error": "text"
}

OK