Update config

Update config

post

Update config

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

projectIdintegerRequired

Project ID

Body

namestringOptional

targetLatencyintegerRequired

Target latency in MS

Example: 0

compilerstring[]Optional

precisionstring[]Optional

trainingCyclesintegerOptional

Maximum number of training cycles

Example: 5

tuningMaxTrialsintegerOptional

Maximum number of trials

Example: 2

tuningWorkersintegerOptional

Maximum number of parallel workers/jobs

Example: 1

initialTrialsintegerOptional

Number of initial trials

Example: 5

optimizationRoundsintegerOptional

Number of optimization rounds

Example: 3

trialsPerOptimizationRoundintegerOptional

Number of trials per optimization round

Example: 3

minMACCSnumberOptional

maxMACCSnumberOptional

tuningAlgorithmstring · enumOptional

Tuning algorithm to use to search hyperparameter space

Possible values:

notificationOnCompletionbooleanOptional

importProjectMetricsbooleanOptional

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

importResourceMetricsbooleanOptional

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

numImportProjectMetricsnumberOptional

Number of project trials to import

numImportResourceMetricsnumberOptional

Number of resource usage trials to import

enableSEMbooleanOptional

Enable standard error of the mean (SEM)

accuracySEMnumberOptional

Standard error of the trial accuracy mean

latencySEMnumberOptional

Standard error of the trial latency mean

rawObjectivesstringOptional

Hyperparameter optimization objectives + weights in string format

optimizationPrecisionstring · enumOptional

Model variant to optimize for

Possible values:

earlyStoppingbooleanOptional

Enable trial level early stopping based on loss metrics during training

earlyStoppingWindowSizenumberOptional

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

earlyStoppingImprovementBarnumberOptional

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

MOMFbooleanOptional

Enable Multi-fidelity Multi-Objective optimization

verboseLoggingbooleanOptional

Enable verbose logging

disableConstraintsbooleanOptional

Disable search constraints

disableDeduplicatebooleanOptional

Disable trial deduplication

maxTotalTrainingTimenumberOptional

Maximum total training time in seconds

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /v1/api/{projectId}/optimize/config HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1300

{
  "name": "text",
  "targetLatency": 0,
  "targetDevice": {
    "name": "cortex-m4f-80mhz",
    "ram": 1024,
    "rom": 1024
  },
  "compiler": [
    "text"
  ],
  "precision": [
    "text"
  ],
  "trainingCycles": 5,
  "tuningMaxTrials": 2,
  "tuningWorkers": 1,
  "initialTrials": 5,
  "optimizationRounds": 3,
  "trialsPerOptimizationRound": 3,
  "minMACCS": 1,
  "maxMACCS": 1,
  "tuningAlgorithm": "random",
  "notificationOnCompletion": true,
  "importProjectMetrics": true,
  "importResourceMetrics": true,
  "numImportProjectMetrics": 1,
  "numImportResourceMetrics": 1,
  "enableSEM": true,
  "accuracySEM": 1,
  "latencySEM": 1,
  "optimizationObjectives": [
    {
      "objective": "text",
      "label": "text",
      "weight": 1
    }
  ],
  "rawObjectives": "text",
  "optimizationPrecision": "float32",
  "earlyStopping": true,
  "earlyStoppingWindowSize": 1,
  "earlyStoppingImprovementBar": 1,
  "MOMF": true,
  "verboseLogging": true,
  "disableConstraints": true,
  "disableDeduplicate": true,
  "maxTotalTrainingTime": 1,
  "tunerSpaceOptions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "space": [
    {
      "parameters": {},
      "inputBlocks": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "dspBlocks": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "learnBlocks": [
        [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ]
      ]
    }
  ],
  "searchSpaceTemplate": {
    "identifier": "speech_keyword",
    "classification": true,
    "anomaly": true,
    "regression": true
  },
  "searchSpaceSource": {
    "type": "template",
    "templateTitle": "text",
    "runTitle": "text",
    "impulseTitle": "text"
  }
}

200

OK

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