TAO Toolkit API (v5.0.0)

Download OpenAPI specification:Download

TAO Toolkit API document

DATASET

Endpoints related to Dataset

List Datasets

Returns the list of Datasets

path Parameters

user_id

required

string <uuid>

User ID

query Parameters

skip	integer Optional skip for pagination
size	integer Optional size for pagination
sort	string Enum: "date-descending" "date-ascending" "name-descending" "name-ascending" Optional sort
name	string Optional name filter
type	string Enum: "object_detection" "semantic_segmentation" "image_classification" Optional type filter

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti",
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
]
}
]

Create new Dataset

Returns the new Dataset

path Parameters

user_id

required

string <uuid>

User ID

Request Body schema: application/json

Initial metadata for new Dataset (type and format required)

name	string
description	string
version	string
logo	string <url>
type	string Enum: "object_detection" "semantic_segmentation" "image_classification" "instance_segmentation" "character_recognition" "bpnet" "fpenet" "action_recognition" "pointpillars" "pose_classification" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "re_identification"
format	string Enum: "kitti" "pascal_voc" "raw" "coco_raw" "unet" "coco" "lprnet" "default" "custom" "classification_pyt"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti"
}

Response samples

201
400

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti",
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
]
}

Retrieve Dataset

Returns the Dataset

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset to return

Responses

Response samples

200
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti",
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
]
}

Delete Dataset

Cancels all related running jobs and returns the deleted Dataset

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset to delete

Responses

Response samples

200
400
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti",
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
]
}

Update Dataset

Returns the updated Dataset

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset to update

Request Body schema: application/json

Updated metadata for Dataset

name	string
description	string
version	string
logo	string <url>
type	string Enum: "object_detection" "semantic_segmentation" "image_classification" "instance_segmentation" "character_recognition" "bpnet" "fpenet" "action_recognition" "pointpillars" "pose_classification" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "re_identification"
format	string Enum: "kitti" "pascal_voc" "raw" "coco_raw" "unet" "coco" "lprnet" "default" "custom" "classification_pyt"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti"
}

Response samples

200
400
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti",
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
]
}

Partial update Dataset

Returns the updated Dataset

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset to update

Request Body schema: application/json

Updated metadata for Dataset

name	string
description	string
version	string
logo	string <url>
type	string Enum: "object_detection" "semantic_segmentation" "image_classification" "instance_segmentation" "character_recognition" "bpnet" "fpenet" "action_recognition" "pointpillars" "pose_classification" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "re_identification"
format	string Enum: "kitti" "pascal_voc" "raw" "coco_raw" "unet" "coco" "lprnet" "default" "custom" "classification_pyt"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti"
}

Response samples

200
400
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"type": "object_detection",
"format": "kitti",
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
]
}

Upload Dataset

Upload training and testing data

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset

Request Body schema: multipart/form-data

Data file to upload (a tar.gz file)

message

string or null

Responses

Response samples

400
404

Content type

application/json

{"error_desc": "string",
"error_code": 0
}

Retrieve Specs schema

Returns the Specs schema for a given action

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID for Dataset
action required	string Action name

Responses

Response samples

200
404

Content type

application/json

{ }

Retrieve Dataset Specs

Returns the saved Dataset Specs for a given action

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset
action required	string Action name

Responses

Response samples

200
404

Content type

application/json

{ }

Save Dataset Specs

Save the Dataset Specs for a given action

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset
action required	string Action name

Request Body schema: application/json

Dataset Specs

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201
400
404

Content type

application/json

{ }

Update Dataset Specs

Update the Dataset Specs for a given action

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset
action required	string Action name

Request Body schema: application/json

Dataset Specs

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
404

Content type

application/json

{ }

Run Dataset Jobs

Asynchronously starts a list of Dataset Actions and returns corresponding Job IDs

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID for Dataset

Request Body schema: application/json

Array

actions	Array of strings
job	string or null <uuid>

Responses

Request samples

Payload

Content type

application/json

[{"actions": ["string"
],
"job": "4bbaedb0-902b-4b27-8218-8f40d3470a54"
}
]

Response samples

201
404

Content type

application/json

["string"
]

List Jobs for Dataset

Returns the list of Jobs

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID for Dataset

query Parameters

skip	integer Optional skip for pagination
size	integer Optional size for pagination
sort	string Enum: "date-descending" "date-ascending" Optional sort

Responses

Response samples

200
404

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
]

Retrieve Job for Dataset

Returns the Job

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset
job_id required	string <uuid> Job ID

Responses

Response samples

200
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}

Delete Dataset Job

delete Dataset Job

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID for Dataset
job_id required	string <uuid> ID for Job

Responses

Response samples

400
404

Content type

application/json

{"error_desc": "string",
"error_code": 0
}

Cancel Dataset Job

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID for Dataset
job_id required	string <uuid> ID for Job

Responses

Response samples

404

Content type

application/json

{"error_desc": "string",
"error_code": 0
}

Download Job Artifacts

Download the Artifacts produced by a given job

path Parameters

user_id required	string <uuid> User ID
dataset_id required	string <uuid> ID of Dataset
job_id required	string <uuid> Job ID

Responses

Response samples

404

Content type

application/json

{"error_desc": "string",
"error_code": 0
}

MODEL

Endpoints related to Model

List Models

Returns the list of Models

path Parameters

user_id

required

string <uuid>

User ID

query Parameters

skip	integer Optional skip for pagination
size	integer Optional size for pagination
sort	string Enum: "date-descending" "date-ascending" "name-descending" "name-ascending" Optional sort
name	string Optional name filter
arch	string Value: "detectnet_v2" Optional network architecture filter
read_only	boolean Optional read_only filter

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"dataset_type": "object_detection",
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true,
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
],
"automl_enabled": true,
"automl_algorithm": "string",
"automl_max_recommendations": 0,
"automl_delete_intermediate_ckpt": true,
"automl_R": 0,
"automl_nu": 0,
"metric": "string",
"epoch_multiplier": 0,
"automl_add_hyperparameters": "string",
"automl_remove_hyperparameters": "string"
}
]

Create new Model

Returns the new Model

path Parameters

user_id

required

string <uuid>

User ID

Request Body schema: application/json

Initial metadata for new Model (ptm or network_arch required)

name	string
description	string
version	string
logo	string <url>
ngc_path	string
additional_id_info	string
encryption_key required	string
network_arch	string Enum: "detectnet_v2" "faster_rcnn" "yolo_v4" "yolo_v4_tiny" "yolo_v3" "ssd" "dssd" "retinanet" "unet" "lprnet" "classification_tf1" "classification_tf2" "efficientdet_tf1" "efficientdet_tf2" "mask_rcnn" "multitask_classification" "bpnet" "fpenet" "action_recognition" "classification_pyt" "mal" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "pointpillars" "pose_classification" "re_identification" "deformable_detr" "dino" "segformer" "annotations" "analytics" "augmentation" "auto_label"
ptm	Array of strings <uuid>
eval_dataset	string <uuid>
inference_dataset	string <uuid>
calibration_dataset	string <uuid>
train_datasets	Array of strings <uuid>
read_only	boolean
public	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true
}

Response samples

201
400

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"dataset_type": "object_detection",
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true,
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
],
"automl_enabled": true,
"automl_algorithm": "string",
"automl_max_recommendations": 0,
"automl_delete_intermediate_ckpt": true,
"automl_R": 0,
"automl_nu": 0,
"metric": "string",
"epoch_multiplier": 0,
"automl_add_hyperparameters": "string",
"automl_remove_hyperparameters": "string"
}

Retrieve Model

Returns the Model

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model to return

Responses

Response samples

200
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"dataset_type": "object_detection",
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true,
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
],
"automl_enabled": true,
"automl_algorithm": "string",
"automl_max_recommendations": 0,
"automl_delete_intermediate_ckpt": true,
"automl_R": 0,
"automl_nu": 0,
"metric": "string",
"epoch_multiplier": 0,
"automl_add_hyperparameters": "string",
"automl_remove_hyperparameters": "string"
}

Delete Model

Cancels all related running jobs and returns the deleted Model

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model to delete

Responses

Response samples

200
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"dataset_type": "object_detection",
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true,
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
],
"automl_enabled": true,
"automl_algorithm": "string",
"automl_max_recommendations": 0,
"automl_delete_intermediate_ckpt": true,
"automl_R": 0,
"automl_nu": 0,
"metric": "string",
"epoch_multiplier": 0,
"automl_add_hyperparameters": "string",
"automl_remove_hyperparameters": "string"
}

Update Model

Returns the updated Model

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model to update

Request Body schema: application/json

Updated metadata for Model

name	string
description	string
version	string
logo	string <url>
ngc_path	string
additional_id_info	string
encryption_key required	string
network_arch	string Enum: "detectnet_v2" "faster_rcnn" "yolo_v4" "yolo_v4_tiny" "yolo_v3" "ssd" "dssd" "retinanet" "unet" "lprnet" "classification_tf1" "classification_tf2" "efficientdet_tf1" "efficientdet_tf2" "mask_rcnn" "multitask_classification" "bpnet" "fpenet" "action_recognition" "classification_pyt" "mal" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "pointpillars" "pose_classification" "re_identification" "deformable_detr" "dino" "segformer" "annotations" "analytics" "augmentation" "auto_label"
ptm	Array of strings <uuid>
eval_dataset	string <uuid>
inference_dataset	string <uuid>
calibration_dataset	string <uuid>
train_datasets	Array of strings <uuid>
read_only	boolean
public	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true
}

Response samples

200
400
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"dataset_type": "object_detection",
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true,
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
],
"automl_enabled": true,
"automl_algorithm": "string",
"automl_max_recommendations": 0,
"automl_delete_intermediate_ckpt": true,
"automl_R": 0,
"automl_nu": 0,
"metric": "string",
"epoch_multiplier": 0,
"automl_add_hyperparameters": "string",
"automl_remove_hyperparameters": "string"
}

Partial update Model

Returns the updated Model

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model to update

Request Body schema: application/json

Updated metadata for Model

name	string
description	string
version	string
logo	string <url>
ngc_path	string
additional_id_info	string
encryption_key required	string
network_arch	string Enum: "detectnet_v2" "faster_rcnn" "yolo_v4" "yolo_v4_tiny" "yolo_v3" "ssd" "dssd" "retinanet" "unet" "lprnet" "classification_tf1" "classification_tf2" "efficientdet_tf1" "efficientdet_tf2" "mask_rcnn" "multitask_classification" "bpnet" "fpenet" "action_recognition" "classification_pyt" "mal" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "pointpillars" "pose_classification" "re_identification" "deformable_detr" "dino" "segformer" "annotations" "analytics" "augmentation" "auto_label"
ptm	Array of strings <uuid>
eval_dataset	string <uuid>
inference_dataset	string <uuid>
calibration_dataset	string <uuid>
train_datasets	Array of strings <uuid>
read_only	boolean
public	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true
}

Response samples

200
400
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"version": "string",
"logo": "string",
"ngc_path": "string",
"additional_id_info": "string",
"encryption_key": "string",
"network_arch": "detectnet_v2",
"ptm": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"dataset_type": "object_detection",
"eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
"inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
"calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
"train_datasets": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"read_only": true,
"public": true,
"actions": ["string"
],
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
],
"automl_enabled": true,
"automl_algorithm": "string",
"automl_max_recommendations": 0,
"automl_delete_intermediate_ckpt": true,
"automl_R": 0,
"automl_nu": 0,
"metric": "string",
"epoch_multiplier": 0,
"automl_add_hyperparameters": "string",
"automl_remove_hyperparameters": "string"
}

Retrieve Specs schema

Returns the Specs schema for a given action

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID for Model
action required	string Action name

Responses

Response samples

200
404

Content type

application/json

{ }

Retrieve Model Specs

Returns the Model Specs for a given action

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model
action required	string Action name

Responses

Response samples

200
404

Content type

application/json

{ }

Save Model Specs

Save the Model Specs for a given action

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model
action required	string Action name

Request Body schema: application/json

Model Specs

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201
400
404

Content type

application/json

{ }

Update Model Specs

Update the Model Specs for a given action

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model
action required	string Action name

Request Body schema: application/json

Model Specs

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
400
404

Content type

application/json

{ }

Run Model Jobs

Asynchronously starts a list of Model Actions and returns corresponding Job IDs

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID for Model

Request Body schema: application/json

Array

actions	Array of strings
job	string or null <uuid>

Responses

Request samples

Payload

Content type

application/json

[{"actions": ["string"
],
"job": "4bbaedb0-902b-4b27-8218-8f40d3470a54"
}
]

Response samples

201
404

Content type

application/json

["string"
]

List Jobs for Model

Returns the list of Jobs

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID for Model

query Parameters

skip	integer Optional skip for pagination
size	integer Optional size for pagination
sort	string Enum: "date-descending" "date-ascending" Optional sort

Responses

Response samples

200
404

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}
]

Retrieve Job for Model

Returns the Job

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model
job_id required	string <uuid> Job ID

Responses

Response samples

200
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"created_on": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"action": "string",
"status": "Done",
"result": {"detailed_status": {"date": "string",
"time": "string",
"message": "string",
"status": "string"
},
"graphical": [{"metric": "string",
"x_min": 0,
"x_max": 0,
"y_min": 0,
"y_max": 0,
"values": {"property1": 0,
"property2": 0
},
"units": "string"
}
],
"categorical": [{"metric": "string",
"category_wise_values": [{"category": "string",
"value": 0
}
]
}
],
"kpi": [{"metric": "string",
"values": {"property1": 0,
"property2": 0
}
}
],
"automl_result": [{"metric": "string",
"value": 0
}
],
"stats": [{"metric": "string",
"value": "string"
}
],
"epoch": 0,
"max_epoch": 0,
"time_per_epoch": "string",
"time_per_iter": "string",
"cur_iter": 0,
"eta": "string"
}
}

Cancel Model Job or pause training

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID for Model
job_id required	string <uuid> ID for Job

Responses

Response samples

404

Content type

application/json

{"error_desc": "string",
"error_code": 0
}

Cancel Model Job or pause training

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID for Model
job_id required	string <uuid> ID for Job

Responses

Response samples

404

Content type

application/json

{"error_desc": "string",
"error_code": 0
}

Resume Model Job

Resume Model Job - train/retrain only

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID for Model
job_id required	string <uuid> ID for Job

Responses

Response samples

404

Content type

application/json

{"error_desc": "string",
"error_code": 0
}

Download Job Artifacts

Download the Artifacts produced by a given job

path Parameters

user_id required	string <uuid> User ID
model_id required	string <uuid> ID of Model
job_id required	string <uuid> Job ID

Responses

Response samples

404

Content type

application/json

{"error_desc": "string",
"error_code": 0
}