Keras metadata

Keras metadata

Get metadata about a trained Keras block. Use the impulse blocks to find the learnId.

get

/api/{projectId}/training/keras/{learnId}/metadata

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

learnIdintegerrequired

Learn Block ID, use the impulse functions to retrieve the ID

Query parameters

excludeLabelsboolean

If set to "true", the "labels" field is left empty (which can be big on e.g. regression projects).

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/training/keras/{learnId}/metadata' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "created": "2025-02-21T18:13:57.422Z",
  "recommendedModelType": "int8",
  "hasTrainedModel": true,
  "objectDetectionLastLayer": "mobilenet-ssd",
  "imageInputScaling": "0..1",
  "mode": "classification",
  "layers": [
    {
      "input": {
        "shape": 33,
        "name": "x_input:0",
        "type": "<dtype: 'float32'>"
      },
      "output": {
        "shape": 20,
        "name": "dense_1/Relu:0",
        "type": "<dtype: 'float32'>"
      }
    }
  ],
  "classNames": [
    "text"
  ],
  "labels": [
    "text"
  ],
  "availableModelTypes": [
    "int8"
  ],
  "modelValidationMetrics": [
    {
      "type": "int8",
      "loss": 1,
      "accuracy": 1,
      "report": {},
      "isSupportedOnMcu": true,
      "mcuSupportError": "text",
      "profilingJobId": 1,
      "profilingJobFailed": true,
      "visualization": "featureExplorer",
      "predictions": [
        {
          "sampleId": 1,
          "startMs": 1,
          "endMs": 1,
          "label": "text",
          "prediction": "text",
          "predictionCorrect": true,
          "f1Score": 1,
          "anomalyScores": [
            [
              1
            ]
          ]
        }
      ],
      "additionalMetrics": [
        {
          "name": "text",
          "value": "text",
          "fullPrecisionValue": 1,
          "tooltipText": "text",
          "link": "text"
        }
      ],
      "confusionMatrix": [
        [
          31,
          1,
          0
        ],
        [
          2,
          27,
          3
        ],
        [
          1,
          0,
          39
        ]
      ],
      "onDevicePerformance": [
        {
          "mcu": "text",
          "name": "text",
          "isDefault": true,
          "latency": 1,
          "customMetrics": [
            {
              "name": "text",
              "value": "text"
            }
          ],
          "tflite": {
            "ramRequired": 1,
            "romRequired": 1,
            "arenaSize": 1,
            "modelSize": 1
          },
          "eon": {
            "ramRequired": 1,
            "romRequired": 1,
            "arenaSize": 1,
            "modelSize": 1
          },
          "eon_ram_optimized": {
            "ramRequired": 1,
            "romRequired": 1,
            "arenaSize": 1,
            "modelSize": 1
          }
        }
      ]
    }
  ]
}

OK