Get TFLite profile result (GET)

Get the results from a job started from startProfileTfliteJob (via a GET request).

GET /api/{projectId}/jobs/profile-tflite/{jobId}/result

Try it

Get TFLite profile result (GET)

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/profile-tflite/{jobId}/result \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "variant": "int8",
  "device": "<string>",
  "tfliteFileSizeBytes": 123,
  "isSupportedOnMcu": true,
  "customMetrics": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "hasPerformance": true,
  "error": "<string>",
  "memory": {
    "tflite": {
      "ram": 123,
      "rom": 123,
      "arenaSize": 123
    },
    "eon": {
      "ram": 123,
      "rom": 123,
      "arenaSize": 123
    },
    "eonRamOptimized": {
      "ram": 123,
      "rom": 123,
      "arenaSize": 123
    }
  },
  "timePerInferenceMs": 123,
  "mcuSupportError": "<string>",
  "profilingError": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

jobId · integer · required

Job ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

variant · enum<string> · required

Available options: int8, float32, akida

device · string · required

tfliteFileSizeBytes · integer · required

isSupportedOnMcu · boolean · required

customMetrics · object[] · required

Custom, device-specific performance metrics

Show child attributes

customMetrics. name · string · required

The name of the metric

customMetrics. value · string · required

The value of this metric for this model type

hasPerformance · boolean · required

If false, then no metrics are available for this target

error · string

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

memory · object

Show child attributes

memory. tflite · object

Show child attributes

memory.tflite. ram · integer · required

Estimated amount of RAM required by the model, measured in bytes

memory.tflite. rom · integer · required

Estimated amount of ROM required by the model, measured in bytes

memory.tflite. arenaSize · integer · required

Estimated arena size required for model inference, measured in bytes

memory. eon · object

Show child attributes

memory.eon. ram · integer · required

Estimated amount of RAM required by the model, measured in bytes

memory.eon. rom · integer · required

Estimated amount of ROM required by the model, measured in bytes

memory.eon. arenaSize · integer · required

Estimated arena size required for model inference, measured in bytes

memory. eonRamOptimized · object

Show child attributes

memory.eonRamOptimized. ram · integer · required

Estimated amount of RAM required by the model, measured in bytes

memory.eonRamOptimized. rom · integer · required

Estimated amount of ROM required by the model, measured in bytes

memory.eonRamOptimized. arenaSize · integer · required

Estimated arena size required for model inference, measured in bytes

timePerInferenceMs · integer

mcuSupportError · string

profilingError · string

Specific error during profiling (e.g. model not supported)