API docs by Redocly

NVIDIA TAO API (5.3.0)

Download OpenAPI specification:Download

NVIDIA TAO (Train, Adapt, Optimize) API document

AUTHENTICATION

Endpoints related to User Authentication

User Login

Returns the user credentials

Authorizations:
api-key
Request Body schema: application/json
required

Login request with ngc_api_key

ngc_api_key
string <regex> <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "ngc_api_key": "/regex/"
}

Response samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "token": "/regex/"
}

DATASET

Endpoints related to Datasets

Given dataset type return dataset formats or return all formats

Given dataset type return dataset formats or return all formats

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

Responses

Response samples

Content type
application/json
{
  • "accepted_dataset_intents": [
    ],
  • "dataset_formats": [
    ]
}

List Datasets

Returns the list of Datasets

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

query Parameters
skip
integer <int32> [ 0 .. 2147483647 ]

Optional skip for pagination

size
integer <int32> [ 0 .. 2147483647 ]

Optional size for pagination

sort
string
Enum: "date-descending" "date-ascending" "name-descending" "name-ascending"

Optional sort

name
string <= 5000 characters .*

Optional name filter

format
string
Enum: "kitti" "pascal_voc" "raw" "coco_raw" "unet" "coco" "lprnet" "train" "test" "default" "custom" "classification_pyt" "classification_tf2" "visual_changenet_segment" "visual_changenet_classify"

Optional format filter

type
string
Enum: "object_detection" "semantic_segmentation" "image_classification" "instance_segmentation" "character_recognition" "action_recognition" "pointpillars" "pose_classification" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "re_identification" "visual_changenet" "centerpose"

Optional type filter

Responses

Response samples

Content type
application/json
{
  • "datasets": [
    ],
  • "pagination_info": {
    }
}

Create new Dataset

Returns the new Dataset

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

Request Body schema: application/json
required

Initial metadata for new Dataset (type and format required)

name
string <regex> <= 500 characters
user_id
string <uuid> <= 36 characters
description
string <regex> <= 1000 characters
object
version
string <regex> <= 10 characters
logo
string <url> <= 2048 characters
type
string
Enum: "object_detection" "semantic_segmentation" "image_classification" "instance_segmentation" "character_recognition" "action_recognition" "pointpillars" "pose_classification" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "re_identification" "visual_changenet" "centerpose" "not_restricted" "user_custom"
format
string
Enum: "kitti" "pascal_voc" "raw" "coco_raw" "unet" "coco" "lprnet" "train" "test" "default" "custom" "classification_pyt" "classification_tf2" "visual_changenet_segment" "visual_changenet_classify" "monai"
object (CloudPull)
client_url
string or null <regex> <= 2048 characters
client_id
string or null <regex> <= 2048 characters
client_secret
string or null <regex> <= 2048 characters
filters
string or null <regex> <= 2048 characters
status
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
use_for
Array of strings or null <= 3 items
Enum: "training" "evaluation" "testing"

Responses

Request samples

Content type
application/json
Example
{
  • "cloud_details": {
    }
}

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "cloud_details": {
    },
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

Retrieve Dataset

Returns the Dataset

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID of Dataset to return

Responses

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "cloud_details": {
    },
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

Delete Dataset

Cancels all related running jobs and returns the deleted Dataset

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID of Dataset to delete

Responses

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "cloud_details": {
    },
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

Update Dataset

Returns the updated Dataset

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID of Dataset to update

Request Body schema: application/json
required

Updated metadata for Dataset

name
string <regex> <= 500 characters
user_id
string <uuid> <= 36 characters
description
string <regex> <= 1000 characters
object
version
string <regex> <= 10 characters
logo
string <url> <= 2048 characters
type
string
Enum: "object_detection" "semantic_segmentation" "image_classification" "instance_segmentation" "character_recognition" "action_recognition" "pointpillars" "pose_classification" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "re_identification" "visual_changenet" "centerpose" "not_restricted" "user_custom"
format
string
Enum: "kitti" "pascal_voc" "raw" "coco_raw" "unet" "coco" "lprnet" "train" "test" "default" "custom" "classification_pyt" "classification_tf2" "visual_changenet_segment" "visual_changenet_classify" "monai"
object (CloudPull)
client_url
string or null <regex> <= 2048 characters
client_id
string or null <regex> <= 2048 characters
client_secret
string or null <regex> <= 2048 characters
filters
string or null <regex> <= 2048 characters
status
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
use_for
Array of strings or null <= 3 items
Enum: "training" "evaluation" "testing"

Responses

Request samples

Content type
application/json
{
  • "name": "/regex/",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "docker_env_vars": {
    },
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "cloud_details": {
    },
  • "client_url": "/regex/",
  • "client_id": "/regex/",
  • "client_secret": "/regex/",
  • "filters": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "cloud_details": {
    },
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

Partial update Dataset

Returns the updated Dataset

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID of Dataset to update

Request Body schema: application/json
required

Updated metadata for Dataset

name
string <regex> <= 500 characters
user_id
string <uuid> <= 36 characters
description
string <regex> <= 1000 characters
object
version
string <regex> <= 10 characters
logo
string <url> <= 2048 characters
type
string
Enum: "object_detection" "semantic_segmentation" "image_classification" "instance_segmentation" "character_recognition" "action_recognition" "pointpillars" "pose_classification" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "re_identification" "visual_changenet" "centerpose" "not_restricted" "user_custom"
format
string
Enum: "kitti" "pascal_voc" "raw" "coco_raw" "unet" "coco" "lprnet" "train" "test" "default" "custom" "classification_pyt" "classification_tf2" "visual_changenet_segment" "visual_changenet_classify" "monai"
object (CloudPull)
client_url
string or null <regex> <= 2048 characters
client_id
string or null <regex> <= 2048 characters
client_secret
string or null <regex> <= 2048 characters
filters
string or null <regex> <= 2048 characters
status
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
use_for
Array of strings or null <= 3 items
Enum: "training" "evaluation" "testing"

Responses

Request samples

Content type
application/json
{
  • "name": "/regex/",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "docker_env_vars": {
    },
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "cloud_details": {
    },
  • "client_url": "/regex/",
  • "client_id": "/regex/",
  • "client_secret": "/regex/",
  • "filters": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "cloud_details": {
    },
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

Retrieve Specs schema

Returns the Specs schema for a given action

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID for Dataset

action
required
string
Enum: "dataset_convert" "convert" "convert_efficientdet_tf2" "kmeans" "augment" "train" "evaluate" "prune" "retrain" "export" "gen_trt_engine" "trtexec" "inference" "annotation" "analyze" "validate" "generate" "calibration_tensorfile"

Action name

Responses

Response samples

Content type
application/json
{ }

Run Dataset Jobs

Asynchronously starts a dataset action and returns corresponding Job ID

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID for Dataset

Request Body schema: application/json
platform
string or null
Enum: "t4" "l4" "l40" "a10" "a30" "a40" "a100" "v100"
parent_job_id
string or null <uuid> <= 36 characters
num_gpu
integer or null <int64> [ 0 .. 9223372036854776000 ]
action
string
Enum: "dataset_convert" "convert" "convert_efficientdet_tf2" "train" "evaluate" "prune" "retrain" "export" "gen_trt_engine" "trtexec" "inference" "batchinfer" "augment" "annotation_format_convert" "analyze" "validate" "generate" "calibration_tensorfile" "annotation" "nextimage" "cacheimage" "notify" "auto3dseg"
name
string or null <regex> <= 500 characters
specs
any
description
string or null <regex> <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "platform": "t4",
  • "parent_job_id": "dd63d5e7-6727-402c-8127-3fd32aa9072a",
  • "num_gpu": 9223372036854776000,
  • "action": "dataset_convert",
  • "name": "/regex/",
  • "specs": null,
  • "description": "/regex/"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

List Jobs for Dataset

Returns the list of Jobs

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <= 36 characters .*

ID for Dataset

query Parameters
skip
integer <int32> [ 0 .. 2147483647 ]

Optional skip for pagination

size
integer <int32> [ 0 .. 2147483647 ]

Optional size for pagination

sort
string
Enum: "date-descending" "date-ascending"

Optional sort

Responses

Response samples

Content type
application/json
{
  • "jobs": [
    ],
  • "pagination_info": {
    }
}

Retrieve Job for Dataset

Returns the Job

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID of Dataset

job_id
required
string <uuid> <= 36 characters

Job ID

Responses

Response samples

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": "dataset_convert",
  • "status": "Done",
  • "result": {
    },
  • "specs": null,
  • "name": "/regex/",
  • "description": "/regex/",
  • "num_gpu": 9223372036854776000,
  • "platform": "t4",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0"
}

Delete Dataset Job

delete Dataset Job

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID for Dataset

job_id
required
string <uuid> <= 36 characters

ID for Job

Responses

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

Cancel Dataset Job

Cancel Dataset Job

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID for Dataset

job_id
required
string <uuid> <= 36 characters

ID for Job

Responses

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

Download Job Artifacts

Download the Artifacts produced by a given job

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

dataset_id
required
string <uuid> <= 36 characters

ID of Dataset

job_id
required
string <uuid> <= 36 characters

Job ID

Responses

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

EXPERIMENT

Endpoints related to Experiments

List Experiments

Returns the list of Experiments

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

query Parameters
skip
integer <int32> [ 0 .. 2147483647 ]

Optional skip for pagination

size
integer <int32> [ 0 .. 2147483647 ]

Optional size for pagination

sort
string
Enum: "date-descending" "date-ascending" "name-descending" "name-ascending"

Optional sort

name
string <= 5000 characters .*

Optional name filter

type
string
Enum: "vision" "medical"

Optional type filter

network_arch
string
Enum: "detectnet_v2" "unet" "classification_tf2" "efficientdet_tf2" "action_recognition" "classification_pyt" "mal" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "pointpillars" "pose_classification" "re_identification" "deformable_detr" "dino" "segformer" "visual_changenet" "centerpose"

Optional network architecture filter

read_only
boolean

Optional read_only filter

user_only
boolean

Optional filter to select user owned experiments only

Responses

Response samples

Content type
application/json
{
  • "experiments": [
    ],
  • "pagination_info": {
    }
}

Create new Experiment

Returns the new Experiment

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

Request Body schema: application/json
required

Initial metadata for new Experiment (base_experiment or network_arch required)

name
string <regex> <= 500 characters
user_id
string <uuid> <= 36 characters
description
string <regex> <= 1000 characters
model_description
string <regex> <= 1000 characters
version
string <regex> <= 500 characters
logo
string <url> <= 2048 characters
ngc_path
string <regex> <= 250 characters
object (CloudPull)
sha256_digest
object or null
base_experiment_pull_complete
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
additional_id_info
string or null <regex> <= 100 characters
object
checkpoint_choose_method
string
Enum: "latest_model" "best_model" "from_epoch_number"
object
encryption_key
string <regex> <= 100 characters
network_arch
string
Enum: "detectnet_v2" "unet" "classification_tf2" "efficientdet_tf2" "action_recognition" "classification_pyt" "mal" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "pointpillars" "pose_classification" "re_identification" "deformable_detr" "dino" "segformer" "visual_changenet" "centerpose" "auto_label" "image" "monai_vista3d" "monai_vista2d" "monai_segmentation" "monai_annotation" "monai_classification" "monai_detection" "monai_automl" "monai_custom" "monai_genai" "monai_maisi" "monai_automl_generated"
base_experiment
Array of strings <uuid> <= 2 items [ items <uuid > <= 36 characters ]
eval_dataset
string <uuid> <= 36 characters
inference_dataset
string <uuid> <= 36 characters
calibration_dataset
string <uuid> <= 36 characters
train_datasets
Array of strings <uuid> <= 9223372036854776000 items [ items <uuid > <= 36 characters ]
read_only
boolean
public
boolean
object or null
metric
string or null <regex> <= 100 characters
type
string
Enum: "vision" "medical"
realtime_infer
boolean
model_params
object or null
bundle_url
string or null <regex> <= 1000 characters
realtime_infer_request_timeout
integer or null <int64> [ 0 .. 9223372036854776000 ]

Responses

Request samples

Content type
application/json
Example
{
  • "cloud_details": {
    }
}

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "cloud_details": {
    },
  • "sha256_digest": { },
  • "base_experiment_pull_complete": "starting",
  • "additional_id_info": "/regex/",
  • "checkpoint_choose_method": "latest_model",
  • "checkpoint_epoch_number": {
    },
  • "encryption_key": "/regex/",
  • "network_arch": "detectnet_v2",
  • "base_experiment": [
    ],
  • "dataset_type": "object_detection",
  • "dataset_formats": [
    ],
  • "accepted_dataset_intents": [
    ],
  • "eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
  • "inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
  • "calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
  • "train_datasets": [
    ],
  • "read_only": true,
  • "public": true,
  • "actions": [
    ],
  • "jobs": {
    },
  • "all_jobs_cancel_status": "Done",
  • "automl_settings": {
    },
  • "metric": "/regex/",
  • "type": "vision",
  • "realtime_infer": true,
  • "realtime_infer_support": true,
  • "model_params": { },
  • "realtime_infer_request_timeout": 86400,
  • "bundle_url": "/regex/",
  • "base_experiment_metadata": {
    }
}

List Experiments that can be used for transfer learning

Returns the list of models published in NGC public catalog and private org's model registry

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

query Parameters
skip
integer <int32> [ 0 .. 2147483647 ]

Optional skip for pagination

size
integer <int32> [ 0 .. 2147483647 ]

Optional size for pagination

sort
string
Enum: "date-descending" "date-ascending" "name-descending" "name-ascending"

Optional sort

name
string <= 5000 characters .*

Optional name filter

type
string
Enum: "vision" "medical"

Optional type filter

network_arch
string
Enum: "detectnet_v2" "unet" "classification_tf2" "efficientdet_tf2" "action_recognition" "classification_pyt" "mal" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "pointpillars" "pose_classification" "re_identification" "deformable_detr" "dino" "segformer" "visual_changenet" "centerpose"

Optional network architecture filter

read_only
boolean

Optional read_only filter

user_only
boolean

Optional filter to select user owned experiments only

Responses

Response samples

Content type
application/json
{
  • "experiments": [
    ],
  • "pagination_info": {
    }
}

Retrieve Experiment

Returns the Experiment

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID of Experiment to return

Responses

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "cloud_details": {
    },
  • "sha256_digest": { },
  • "base_experiment_pull_complete": "starting",
  • "additional_id_info": "/regex/",
  • "checkpoint_choose_method": "latest_model",
  • "checkpoint_epoch_number": {
    },
  • "encryption_key": "/regex/",
  • "network_arch": "detectnet_v2",
  • "base_experiment": [
    ],
  • "dataset_type": "object_detection",
  • "dataset_formats": [
    ],
  • "accepted_dataset_intents": [
    ],
  • "eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
  • "inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
  • "calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
  • "train_datasets": [
    ],
  • "read_only": true,
  • "public": true,
  • "actions": [
    ],
  • "jobs": {
    },
  • "all_jobs_cancel_status": "Done",
  • "automl_settings": {
    },
  • "metric": "/regex/",
  • "type": "vision",
  • "realtime_infer": true,
  • "realtime_infer_support": true,
  • "model_params": { },
  • "realtime_infer_request_timeout": 86400,
  • "bundle_url": "/regex/",
  • "base_experiment_metadata": {
    }
}

Delete Experiment

Cancels all related running jobs and returns the deleted Experiment

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID of Experiment to delete

Responses

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "cloud_details": {
    },
  • "sha256_digest": { },
  • "base_experiment_pull_complete": "starting",
  • "additional_id_info": "/regex/",
  • "checkpoint_choose_method": "latest_model",
  • "checkpoint_epoch_number": {
    },
  • "encryption_key": "/regex/",
  • "network_arch": "detectnet_v2",
  • "base_experiment": [
    ],
  • "dataset_type": "object_detection",
  • "dataset_formats": [
    ],
  • "accepted_dataset_intents": [
    ],
  • "eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
  • "inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
  • "calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
  • "train_datasets": [
    ],
  • "read_only": true,
  • "public": true,
  • "actions": [
    ],
  • "jobs": {
    },
  • "all_jobs_cancel_status": "Done",
  • "automl_settings": {
    },
  • "metric": "/regex/",
  • "type": "vision",
  • "realtime_infer": true,
  • "realtime_infer_support": true,
  • "model_params": { },
  • "realtime_infer_request_timeout": 86400,
  • "bundle_url": "/regex/",
  • "base_experiment_metadata": {
    }
}

Update Experiment

Returns the updated Experiment

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID of Experiment to update

Request Body schema: application/json
required

Updated metadata for Experiment

name
string <regex> <= 500 characters
user_id
string <uuid> <= 36 characters
description
string <regex> <= 1000 characters
model_description
string <regex> <= 1000 characters
version
string <regex> <= 500 characters
logo
string <url> <= 2048 characters
ngc_path
string <regex> <= 250 characters
object (CloudPull)
sha256_digest
object or null
base_experiment_pull_complete
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
additional_id_info
string or null <regex> <= 100 characters
object
checkpoint_choose_method
string
Enum: "latest_model" "best_model" "from_epoch_number"
object
encryption_key
string <regex> <= 100 characters
network_arch
string
Enum: "detectnet_v2" "unet" "classification_tf2" "efficientdet_tf2" "action_recognition" "classification_pyt" "mal" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "pointpillars" "pose_classification" "re_identification" "deformable_detr" "dino" "segformer" "visual_changenet" "centerpose" "auto_label" "image" "monai_vista3d" "monai_vista2d" "monai_segmentation" "monai_annotation" "monai_classification" "monai_detection" "monai_automl" "monai_custom" "monai_genai" "monai_maisi" "monai_automl_generated"
base_experiment
Array of strings <uuid> <= 2 items [ items <uuid > <= 36 characters ]
eval_dataset
string <uuid> <= 36 characters
inference_dataset
string <uuid> <= 36 characters
calibration_dataset
string <uuid> <= 36 characters
train_datasets
Array of strings <uuid> <= 9223372036854776000 items [ items <uuid > <= 36 characters ]
read_only
boolean
public
boolean
object or null
metric
string or null <regex> <= 100 characters
type
string
Enum: "vision" "medical"
realtime_infer
boolean
model_params
object or null
bundle_url
string or null <regex> <= 1000 characters
realtime_infer_request_timeout
integer or null <int64> [ 0 .. 9223372036854776000 ]

Responses

Request samples

Content type
application/json
{
  • "name": "/regex/",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "cloud_details": {
    },
  • "sha256_digest": { },
  • "base_experiment_pull_complete": "starting",
  • "additional_id_info": "/regex/",
  • "docker_env_vars": {
    },
  • "checkpoint_choose_method": "latest_model",
  • "checkpoint_epoch_number": {
    },
  • "encryption_key": "/regex/",
  • "network_arch": "detectnet_v2",
  • "base_experiment": [
    ],
  • "eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
  • "inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
  • "calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
  • "train_datasets": [
    ],
  • "read_only": true,
  • "public": true,
  • "automl_settings": {
    },
  • "metric": "/regex/",
  • "type": "vision",
  • "realtime_infer": true,
  • "model_params": { },
  • "bundle_url": "/regex/",
  • "realtime_infer_request_timeout": 9223372036854776000
}

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "cloud_details": {
    },
  • "sha256_digest": { },
  • "base_experiment_pull_complete": "starting",
  • "additional_id_info": "/regex/",
  • "checkpoint_choose_method": "latest_model",
  • "checkpoint_epoch_number": {
    },
  • "encryption_key": "/regex/",
  • "network_arch": "detectnet_v2",
  • "base_experiment": [
    ],
  • "dataset_type": "object_detection",
  • "dataset_formats": [
    ],
  • "accepted_dataset_intents": [
    ],
  • "eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
  • "inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
  • "calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
  • "train_datasets": [
    ],
  • "read_only": true,
  • "public": true,
  • "actions": [
    ],
  • "jobs": {
    },
  • "all_jobs_cancel_status": "Done",
  • "automl_settings": {
    },
  • "metric": "/regex/",
  • "type": "vision",
  • "realtime_infer": true,
  • "realtime_infer_support": true,
  • "model_params": { },
  • "realtime_infer_request_timeout": 86400,
  • "bundle_url": "/regex/",
  • "base_experiment_metadata": {
    }
}

Partial update Experiment

Returns the updated Experiment

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID of Experiment to update

Request Body schema: application/json
required

Updated metadata for Experiment

name
string <regex> <= 500 characters
user_id
string <uuid> <= 36 characters
description
string <regex> <= 1000 characters
model_description
string <regex> <= 1000 characters
version
string <regex> <= 500 characters
logo
string <url> <= 2048 characters
ngc_path
string <regex> <= 250 characters
object (CloudPull)
sha256_digest
object or null
base_experiment_pull_complete
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
additional_id_info
string or null <regex> <= 100 characters
object
checkpoint_choose_method
string
Enum: "latest_model" "best_model" "from_epoch_number"
object
encryption_key
string <regex> <= 100 characters
network_arch
string
Enum: "detectnet_v2" "unet" "classification_tf2" "efficientdet_tf2" "action_recognition" "classification_pyt" "mal" "ml_recog" "ocdnet" "ocrnet" "optical_inspection" "pointpillars" "pose_classification" "re_identification" "deformable_detr" "dino" "segformer" "visual_changenet" "centerpose" "auto_label" "image" "monai_vista3d" "monai_vista2d" "monai_segmentation" "monai_annotation" "monai_classification" "monai_detection" "monai_automl" "monai_custom" "monai_genai" "monai_maisi" "monai_automl_generated"
base_experiment
Array of strings <uuid> <= 2 items [ items <uuid > <= 36 characters ]
eval_dataset
string <uuid> <= 36 characters
inference_dataset
string <uuid> <= 36 characters
calibration_dataset
string <uuid> <= 36 characters
train_datasets
Array of strings <uuid> <= 9223372036854776000 items [ items <uuid > <= 36 characters ]
read_only
boolean
public
boolean
object or null
metric
string or null <regex> <= 100 characters
type
string
Enum: "vision" "medical"
realtime_infer
boolean
model_params
object or null
bundle_url
string or null <regex> <= 1000 characters
realtime_infer_request_timeout
integer or null <int64> [ 0 .. 9223372036854776000 ]

Responses

Request samples

Content type
application/json
{
  • "name": "/regex/",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "cloud_details": {
    },
  • "sha256_digest": { },
  • "base_experiment_pull_complete": "starting",
  • "additional_id_info": "/regex/",
  • "docker_env_vars": {
    },
  • "checkpoint_choose_method": "latest_model",
  • "checkpoint_epoch_number": {
    },
  • "encryption_key": "/regex/",
  • "network_arch": "detectnet_v2",
  • "base_experiment": [
    ],
  • "eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
  • "inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
  • "calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
  • "train_datasets": [
    ],
  • "read_only": true,
  • "public": true,
  • "automl_settings": {
    },
  • "metric": "/regex/",
  • "type": "vision",
  • "realtime_infer": true,
  • "model_params": { },
  • "bundle_url": "/regex/",
  • "realtime_infer_request_timeout": 9223372036854776000
}

Response samples

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": "/regex/",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "cloud_details": {
    },
  • "sha256_digest": { },
  • "base_experiment_pull_complete": "starting",
  • "additional_id_info": "/regex/",
  • "checkpoint_choose_method": "latest_model",
  • "checkpoint_epoch_number": {
    },
  • "encryption_key": "/regex/",
  • "network_arch": "detectnet_v2",
  • "base_experiment": [
    ],
  • "dataset_type": "object_detection",
  • "dataset_formats": [
    ],
  • "accepted_dataset_intents": [
    ],
  • "eval_dataset": "f06341d1-b6f7-4d94-99b1-6d57b5a471e6",
  • "inference_dataset": "287bd7ed-1072-49bc-8d0c-261f29925b9f",
  • "calibration_dataset": "06da9759-37ba-45ac-b600-dfa833bc04e5",
  • "train_datasets": [
    ],
  • "read_only": true,
  • "public": true,
  • "actions": [
    ],
  • "jobs": {
    },
  • "all_jobs_cancel_status": "Done",
  • "automl_settings": {
    },
  • "metric": "/regex/",
  • "type": "vision",
  • "realtime_infer": true,
  • "realtime_infer_support": true,
  • "model_params": { },
  • "realtime_infer_request_timeout": 86400,
  • "bundle_url": "/regex/",
  • "base_experiment_metadata": {
    }
}

Retrieve Specs schema

Returns the Specs schema for a given action

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

action
required
string
Enum: "dataset_convert" "convert" "convert_efficientdet_tf2" "kmeans" "augment" "train" "evaluate" "prune" "retrain" "export" "gen_trt_engine" "trtexec" "inference" "annotation" "analyze" "validate" "generate" "calibration_tensorfile"

Action name

Responses

Response samples

Content type
application/json
{ }

Run Experiment Jobs

Asynchronously starts a Experiment Action and returns corresponding Job ID

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

Request Body schema: application/json
platform
string or null
Enum: "t4" "l4" "l40" "a10" "a30" "a40" "a100" "v100"
parent_job_id
string or null <uuid> <= 36 characters
num_gpu
integer or null <int64> [ 0 .. 9223372036854776000 ]
action
string
Enum: "dataset_convert" "convert" "convert_efficientdet_tf2" "train" "evaluate" "prune" "retrain" "export" "gen_trt_engine" "trtexec" "inference" "batchinfer" "augment" "annotation_format_convert" "analyze" "validate" "generate" "calibration_tensorfile" "annotation" "nextimage" "cacheimage" "notify" "auto3dseg"
name
string or null <regex> <= 500 characters
specs
any
description
string or null <regex> <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "platform": "t4",
  • "parent_job_id": "dd63d5e7-6727-402c-8127-3fd32aa9072a",
  • "num_gpu": 9223372036854776000,
  • "action": "dataset_convert",
  • "name": "/regex/",
  • "specs": null,
  • "description": "/regex/"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

List Jobs for Experiment

Returns the list of Jobs

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <= 36 characters .*

ID for Experiment

query Parameters
skip
integer <int32> [ 0 .. 2147483647 ]

Optional skip for pagination

size
integer <int32> [ 0 .. 2147483647 ]

Optional size for pagination

sort
string
Enum: "date-descending" "date-ascending"

Optional sort

Responses

Response samples

Content type
application/json
{
  • "jobs": [
    ],
  • "pagination_info": {
    }
}

Get epoch numbers present for this job

Get epoch numbers for the checkpoints present for this job

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

job_id
required
string <uuid> <= 36 characters

ID for Job

Responses

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Publish models to NGC

Publish models to NGC private registry

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

job_id
required
string <uuid> <= 36 characters

ID for Job

Request Body schema: application/json
platform
string or null
Enum: "t4" "l4" "l40" "a10" "a30" "a40" "a100" "v100"
parent_job_id
string or null <uuid> <= 36 characters
num_gpu
integer or null <int64> [ 0 .. 9223372036854776000 ]
action
string
Enum: "dataset_convert" "convert" "convert_efficientdet_tf2" "train" "evaluate" "prune" "retrain" "export" "gen_trt_engine" "trtexec" "inference" "batchinfer" "augment" "annotation_format_convert" "analyze" "validate" "generate" "calibration_tensorfile" "annotation" "nextimage" "cacheimage" "notify" "auto3dseg"
name
string or null <regex> <= 500 characters
specs
any
description
string or null <regex> <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "platform": "t4",
  • "parent_job_id": "dd63d5e7-6727-402c-8127-3fd32aa9072a",
  • "num_gpu": 9223372036854776000,
  • "action": "dataset_convert",
  • "name": "/regex/",
  • "specs": null,
  • "description": "/regex/"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Remove publish models from NGC

Remove models from NGC private registry

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

job_id
required
string <uuid> <= 36 characters

ID for Job

Request Body schema: application/json
platform
string or null
Enum: "t4" "l4" "l40" "a10" "a30" "a40" "a100" "v100"
parent_job_id
string or null <uuid> <= 36 characters
num_gpu
integer or null <int64> [ 0 .. 9223372036854776000 ]
action
string
Enum: "dataset_convert" "convert" "convert_efficientdet_tf2" "train" "evaluate" "prune" "retrain" "export" "gen_trt_engine" "trtexec" "inference" "batchinfer" "augment" "annotation_format_convert" "analyze" "validate" "generate" "calibration_tensorfile" "annotation" "nextimage" "cacheimage" "notify" "auto3dseg"
name
string or null <regex> <= 500 characters
specs
any
description
string or null <regex> <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "platform": "t4",
  • "parent_job_id": "dd63d5e7-6727-402c-8127-3fd32aa9072a",
  • "num_gpu": 9223372036854776000,
  • "action": "dataset_convert",
  • "name": "/regex/",
  • "specs": null,
  • "description": "/regex/"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Retrieve Job for Experiment

Returns the Job

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID of Experiment

job_id
required
string <uuid> <= 36 characters

Job ID

Responses

Response samples

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": "dataset_convert",
  • "status": "Done",
  • "result": {
    },
  • "sync": true,
  • "specs": null,
  • "name": "/regex/",
  • "description": "/regex/",
  • "num_gpu": 9223372036854776000,
  • "platform": "t4",
  • "experiment_id": "916afd89-cac5-4339-9c59-dd068abdfa69"
}

Delete Experiment Job

Delete Experiment Job

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

job_id
required
string <uuid> <= 36 characters

ID for Job

Responses

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

Get Job logs for Experiment

Returns the job logs

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID of Experiment

job_id
required
string <uuid> <= 36 characters

Job ID

query Parameters
automl_experiment_index
integer <int32> [ 0 .. 2147483647 ]

Optional filter to retrieve logs from specific autoML experiment

Responses

Response samples

Content type
text/plain
Execution status: PASS

Retrieve usable AutoML details

Retrieve usable AutoML details

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID of Experiment

job_id
required
string <uuid> <= 36 characters

Job ID

Responses

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

Cancel all Jobs under experiment

Cancel all Jobs under experiment

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

Responses

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

Cancel Experiment Job or pause training

Cancel Experiment Job or pause training

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

job_id
required
string <uuid> <= 36 characters

ID for Job

Responses

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

Resume Experiment Job

Resume Experiment Job - train/retrain only

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID for Experiment

job_id
required
string <uuid> <= 36 characters

ID for Job

Request Body schema: application/json
optional

Adjustable metadata for the resumed job.

parent_job_id
string or null <uuid> <= 36 characters
specs
any or null

Responses

Request samples

Content type
application/json
{
  • "parent_job_id": "dd63d5e7-6727-402c-8127-3fd32aa9072a",
  • "specs": null
}

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

Download Job Artifacts

Download the Artifacts produced by a given job

Authorizations:
bearer-token
path Parameters
org_name
required
string <= 255 characters ^[a-zA-Z0-9_-]+$

Org Name

experiment_id
required
string <uuid> <= 36 characters

ID of Experiment

job_id
required
string <uuid> <= 36 characters

Job ID

Responses

Response samples

Content type
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}