Get transfer learning block

Gets a transfer learning block.

GET /api/organizations/{organizationId}/transfer-learning/{transferLearningId}

Try it

Get transfer learning block

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/transfer-learning/{transferLearningId} \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "transferLearningBlock": {
    "id": 123,
    "name": "<string>",
    "dockerContainer": "<string>",
    "dockerContainerManagedByEdgeImpulse": true,
    "created": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "operatesOn": "object_detection",
    "implementationVersion": 123,
    "isPublic": true,
    "isPublicForDevices": [
      "<string>"
    ],
    "isPublicEnterpriseOnly": true,
    "parameters": [
      {}
    ],
    "indRequiresGpu": true,
    "sourceCodeAvailable": true,
    "sourceCodeDownloadStaffOnly": true,
    "indBlockNoLongerAvailable": true,
    "createdByUser": {
      "id": 123,
      "name": "<string>",
      "username": "<string>",
      "photo": "<string>"
    },
    "lastUpdated": "2023-11-07T05:31:56Z",
    "lastUpdatedByUser": {
      "id": 123,
      "name": "<string>",
      "username": "<string>",
      "photo": "<string>"
    },
    "userId": 123,
    "userName": "<string>",
    "objectDetectionLastLayer": "mobilenet-ssd",
    "publicProjectTierAvailability": "enterprise-only",
    "enterpriseOnly": true,
    "repositoryUrl": "<string>",
    "imageInputScaling": "0..1",
    "displayCategory": "classical",
    "customModelVariants": [
      {
        "key": "<string>",
        "name": "<string>",
        "inferencingEntrypoint": "<string>",
        "profilingEntrypoint": "<string>",
        "modelFiles": [
          {
            "id": "<string>",
            "name": "<string>",
            "type": "binary",
            "description": "<string>"
          }
        ]
      }
    ],
    "blockNoLongerAvailableReason": "<string>"
  },
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

transferLearningId · integer · required

Transfer learning ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

transferLearningBlock · object · required

Show child attributes

transferLearningBlock. id · integer · required

transferLearningBlock. name · string · required

transferLearningBlock. dockerContainer · string · required

transferLearningBlock. dockerContainerManagedByEdgeImpulse · boolean · required

transferLearningBlock. created · string<date-time> · required

transferLearningBlock. description · string · required

transferLearningBlock. operatesOn · enum<string> · required

Available options: object_detection, audio, image, regression, other

transferLearningBlock. implementationVersion · integer · required

transferLearningBlock. isPublic · boolean · required

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

transferLearningBlock. isPublicForDevices · string[] · required

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

transferLearningBlock. isPublicEnterpriseOnly · boolean · required

Whether this block is publicly available to only enterprise users

transferLearningBlock. parameters · object[] · required

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

transferLearningBlock. indRequiresGpu · boolean · required

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

transferLearningBlock. sourceCodeAvailable · boolean · required

transferLearningBlock. sourceCodeDownloadStaffOnly · boolean · required

Whether the source code is only available for staff users.

transferLearningBlock. indBlockNoLongerAvailable · boolean · required

If set, then this block is no longer available for training; and blockNoLongerAvailableReason will be set.

transferLearningBlock. createdByUser · object

Show child attributes

transferLearningBlock.createdByUser. id · integer · required

transferLearningBlock.createdByUser. name · string · required

transferLearningBlock.createdByUser. username · string · required

transferLearningBlock.createdByUser. photo · string

transferLearningBlock. lastUpdated · string<date-time>

transferLearningBlock. lastUpdatedByUser · object

Show child attributes

transferLearningBlock.lastUpdatedByUser. id · integer · required

transferLearningBlock.lastUpdatedByUser. name · string · required

transferLearningBlock.lastUpdatedByUser. username · string · required

transferLearningBlock.lastUpdatedByUser. photo · string

transferLearningBlock. userId · integer

transferLearningBlock. userName · string

transferLearningBlock. objectDetectionLastLayer · enum<string>

Available options: mobilenet-ssd, fomo, yolov2-akida, yolov5, yolov5v5-drpai, yolox, yolov7, yolo-pro, tao-retinanet, tao-ssd, tao-yolov3, tao-yolov4, yolov11, yolov11-abs

transferLearningBlock. publicProjectTierAvailability · enum<string>

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

Available options: enterprise-only, pro-or-enterprise, all-projects

transferLearningBlock. enterpriseOnly · boolean

Whether this block is available to only enterprise users

transferLearningBlock. repositoryUrl · string

URL to the source code of this custom learn block.

transferLearningBlock. imageInputScaling · enum<string>

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.

Available options: 0..1, -1..1, -128..127, 0..255, torch, bgr-subtract-imagenet-mean

transferLearningBlock. displayCategory · enum<string>

Category to display this block in the UI.

Available options: classical, tao, developer-preview

transferLearningBlock. customModelVariants · object[]

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

Show child attributes

transferLearningBlock.customModelVariants. key · string · required

Unique identifier or key for this custom variant

transferLearningBlock.customModelVariants. name · string · required

Custom variant display name

transferLearningBlock.customModelVariants. inferencingEntrypoint · string · required

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

transferLearningBlock.customModelVariants. profilingEntrypoint · string

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

transferLearningBlock.customModelVariants. modelFiles · object[]

Show child attributes

transferLearningBlock.customModelVariants.modelFiles. id · string · required

Output artifact unique file ID, in kebab case

transferLearningBlock.customModelVariants.modelFiles. name · string · required

Output artifact file name

transferLearningBlock.customModelVariants.modelFiles. type · enum<string> · required

Output artifact file type

Available options: binary, json, text

transferLearningBlock.customModelVariants.modelFiles. description · string · required

Output artifact file description

transferLearningBlock. blockNoLongerAvailableReason · string

In Markdown format. Set if indBlockNoLongerAvailable is true, contains migration information for existing users of this block.

error · string

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