Get transfer learning blocks

Retrieve all transfer learning blocks.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transfer-learning

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

transferLearningBlocks*array of OrganizationTransferLearningBlock (object)

id*integer

name*string

dockerContainer*string

dockerContainerManagedByEdgeImpulse*boolean

created*string (date-time)

createdByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

lastUpdatedstring (date-time)

lastUpdatedByUserCreatedUpdatedByUser (object)

id*integer

name*string

username*string

photostring

description*string

userIdinteger

userNamestring

operatesOn*OrganizationTransferLearningOperatesOn (enum)

object_detectionaudioimageregressionother

objectDetectionLastLayerObjectDetectionLastLayer (enum)

mobilenet-ssdfomoyolov2-akidayolov5yolov5v5-drpaiyoloxyolov7tao-retinanettao-ssdtao-yolov3tao-yolov4

implementationVersion*integer

isPublic*boolean

Whether this block is publicly available to Edge Impulse users (if false, then only for members of the owning organization)

isPublicForDevices*array of string

If isPublic is true, the list of devices (from latencyDevices) for which this model can be shown.

itemsstring

publicProjectTierAvailabilityPublicProjectTierAvailability (enum)

For public blocks, this indicates the project tiers for which this block is available.

enterprise-onlypro-or-enterpriseall-projects

isPublicEnterpriseOnly*boolean

Whether this block is publicly available to only enterprise users

enterpriseOnlyboolean

Whether this block is available to only enterprise users

repositoryUrlstring

URL to the source code of this custom learn block.

parameters*array of object

List of parameters, spec'ed according to https://docs.edgeimpulse.com/docs/tips-and-tricks/adding-parameters-to-custom-blocks

imageInputScalingImageInputScaling (enum)

Normalization that is applied to images. If this is not set then 0..1 is used. "0..1" gives you non-normalized pixels between 0 and 1. "-1..1" gives you non-normalized pixels between -1 and 1. "0..255" gives you non-normalized pixels between 0 and 255. "-128..127" gives you non-normalized pixels between -128 and 127. "torch" first scales pixels between 0 and 1, then applies normalization using the ImageNet dataset (same as torchvision.transforms.Normalize()). "bgr-subtract-imagenet-mean" scales to 0..255, reorders pixels to BGR, and subtracts the ImageNet mean from each channel.

0..1-1..1-128..1270..255torchbgr-subtract-imagenet-mean

indRequiresGpu*boolean

If set, requires this block to be scheduled on GPU.

sourceCodeAvailable*boolean

displayCategoryBlockDisplayCategory (enum)

Category to display this block in the UI.

classicaltao

customModelVariantsarray of OrganizationTransferLearningBlockCustomVariant (object)

List of custom model variants produced when this block is trained. This is experimental and may change in the future.

key*string

Unique identifier or key for this custom variant

name*string

Custom variant display name

inferencingEntrypoint*string

The entrypoint command to run custom inferencing for this model variant, via the learn block container

profilingEntrypointstring

The entrypoint command to run custom profiling for this model variant, via the learn block container

modelFilesarray of OrganizationTransferLearningBlockModelFile (object)

id*string

Output artifact unique file ID, in kebab case

name*string

Output artifact file name

type*enum

Output artifact file type

binaryjsontext

description*string

Output artifact file description

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transfer-learning', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "transferLearningBlocks": [
    {
      "id": 0,
      "name": "text",
      "dockerContainer": "text",
      "dockerContainerManagedByEdgeImpulse": false,
      "created": "2024-12-03T17:12:53.675Z",
      "createdByUser": {
        "id": 0,
        "name": "text",
        "username": "text",
        "photo": "text"
      },
      "lastUpdated": "2024-12-03T17:12:53.675Z",
      "lastUpdatedByUser": {
        "id": 0,
        "name": "text",
        "username": "text",
        "photo": "text"
      },
      "description": "text",
      "userId": 0,
      "userName": "text",
      "operatesOn": "object_detection",
      "objectDetectionLastLayer": "mobilenet-ssd",
      "implementationVersion": 0,
      "isPublic": false,
      "isPublicForDevices": [
        "text"
      ],
      "publicProjectTierAvailability": "enterprise-only",
      "isPublicEnterpriseOnly": false,
      "enterpriseOnly": false,
      "repositoryUrl": "text",
      "parameters": [],
      "imageInputScaling": "0..1",
      "indRequiresGpu": false,
      "sourceCodeAvailable": false,
      "displayCategory": "classical",
      "customModelVariants": [
        {
          "key": "text",
          "name": "text",
          "inferencingEntrypoint": "text",
          "profilingEntrypoint": "text",
          "modelFiles": [
            {
              "id": "text",
              "name": "text",
              "type": "binary",
              "description": "text"
            }
          ]
        }
      ]
    }
  ]
}