Redocly 提供的 API 文档

NVIDIA TAO API (5.5.0)

下载 OpenAPI 规范:下载

NVIDIA TAO (Train, Adapt, Optimize) API 文档

身份验证

与用户身份验证相关的端点

用户登录

返回用户凭据

授权
api-key
请求体模式: application/json
必需

使用 ngc_api_key 的登录请求

ngc_api_key
string <regex> <= 1000 个字符

响应

请求示例

内容类型
application/json
{
  • "ngc_api_key": "/regex/"
}

响应示例

内容类型
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "token": "/regex/"
}

数据集

与数据集相关的端点

根据数据集类型返回数据集格式或返回所有格式

根据数据集类型返回数据集格式或返回所有格式

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

响应

响应示例

内容类型
application/json
{
  • "accepted_dataset_intents": [
    ],
  • "dataset_formats": [
    ]
}

列出数据集

返回数据集列表

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

查询参数
skip
integer <int32> [ 0 .. 2147483647 ]

可选的跳过页码用于分页

size
integer <int32> [ 0 .. 2147483647 ]

可选的分页大小

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

可选的排序方式

name
string <= 5000 个字符 .*

可选的名称过滤器

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"

可选的格式过滤器

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"

可选的类型过滤器

响应

响应示例

内容类型
application/json
{
  • "datasets": [
    ],
  • "pagination_info": {
    }
}

创建新数据集

返回新的数据集

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

请求体模式: application/json
必需

新数据集的初始元数据（需要类型和格式）

name
string <regex> <= 500 个字符
shared
boolean
user_id
string <uuid> <= 36 个字符
description
string <regex> <= 1000 个字符
object
version
string <regex> <= 10 个字符
logo
string <url> <= 2048 个字符
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"
workspace
string or null <uuid> <= 36 个字符
url
string <url> <= 2048 个字符
cloud_file_path
string or null <regex> <= 2048 个字符
client_url
string or null <regex> <= 2048 个字符
client_id
string or null <regex> <= 2048 个字符
client_secret
string or null <regex> <= 2048 个字符
filters
string or null <regex> <= 2048 个字符
status
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
use_for
Array of strings or null <= 3 items
Enum: "training" "evaluation" "testing"

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "docker_env_vars": {
    },
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "url": "string",
  • "cloud_file_path": "/regex/",
  • "client_url": "/regex/",
  • "client_id": "/regex/",
  • "client_secret": "/regex/",
  • "filters": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "url": "string",
  • "cloud_file_path": "/regex/",
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

检索数据集

返回数据集

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

要返回的数据集 ID

响应

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "url": "string",
  • "cloud_file_path": "/regex/",
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

删除数据集

取消所有相关的正在运行的作业并返回已删除的数据集

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

要删除的数据集 ID

响应

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "url": "string",
  • "cloud_file_path": "/regex/",
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

更新数据集

返回更新后的数据集

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

要更新的数据集 ID

请求体模式: application/json
必需

数据集的更新元数据

name
string <regex> <= 500 个字符
shared
boolean
user_id
string <uuid> <= 36 个字符
description
string <regex> <= 1000 个字符
object
version
string <regex> <= 10 个字符
logo
string <url> <= 2048 个字符
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"
workspace
string or null <uuid> <= 36 个字符
url
string <url> <= 2048 个字符
cloud_file_path
string or null <regex> <= 2048 个字符
client_url
string or null <regex> <= 2048 个字符
client_id
string or null <regex> <= 2048 个字符
client_secret
string or null <regex> <= 2048 个字符
filters
string or null <regex> <= 2048 个字符
status
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
use_for
Array of strings or null <= 3 items
Enum: "training" "evaluation" "testing"

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "docker_env_vars": {
    },
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "url": "string",
  • "cloud_file_path": "/regex/",
  • "client_url": "/regex/",
  • "client_id": "/regex/",
  • "client_secret": "/regex/",
  • "filters": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "url": "string",
  • "cloud_file_path": "/regex/",
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

部分更新数据集

返回更新后的数据集

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

要更新的数据集 ID

请求体模式: application/json
必需

数据集的更新元数据

name
string <regex> <= 500 个字符
shared
boolean
user_id
string <uuid> <= 36 个字符
description
string <regex> <= 1000 个字符
object
version
string <regex> <= 10 个字符
logo
string <url> <= 2048 个字符
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"
workspace
string or null <uuid> <= 36 个字符
url
string <url> <= 2048 个字符
cloud_file_path
string or null <regex> <= 2048 个字符
client_url
string or null <regex> <= 2048 个字符
client_id
string or null <regex> <= 2048 个字符
client_secret
string or null <regex> <= 2048 个字符
filters
string or null <regex> <= 2048 个字符
status
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
use_for
Array of strings or null <= 3 items
Enum: "training" "evaluation" "testing"

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "docker_env_vars": {
    },
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "url": "string",
  • "cloud_file_path": "/regex/",
  • "client_url": "/regex/",
  • "client_id": "/regex/",
  • "client_secret": "/regex/",
  • "filters": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "type": "object_detection",
  • "format": "kitti",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "url": "string",
  • "cloud_file_path": "/regex/",
  • "actions": [
    ],
  • "jobs": {
    },
  • "client_url": "/regex/",
  • "status": "starting",
  • "use_for": [
    ]
}

检索规格模式

返回给定操作的规格模式

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

数据集的 ID

action
必需
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"

操作名称

响应

响应示例

内容类型
application/json
{ }

运行数据集作业

异步启动数据集操作并返回相应的作业 ID

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

数据集的 ID

请求体模式: application/json
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"
parent_job_id
string or null <uuid> <= 36 个字符
name
string or null <regex> <= 500 个字符
description
string 或 null <regex> <= 1000 个字符
specs
any
platform_id
string or null <uuid> <= 36 个字符
num_gpu
integer 或 null <int64> [ 0 .. 9223372036854776000 ]

响应

请求示例

内容类型
application/json
{
  • "action": "dataset_convert",
  • "parent_job_id": "dd63d5e7-6727-402c-8127-3fd32aa9072a",
  • "name": "/regex/",
  • "description": "/regex/",
  • "specs": null,
  • "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  • "num_gpu": 9223372036854776000
}

响应示例

内容类型
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

列出数据集的 Jobs

返回 Jobs 列表

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <= 36 个字符 .*

数据集的 ID

查询参数
skip
integer <int32> [ 0 .. 2147483647 ]

可选的跳过页码用于分页

size
integer <int32> [ 0 .. 2147483647 ]

可选的分页大小

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

可选的排序方式

响应

响应示例

内容类型
application/json
{
  • "jobs": [
    ],
  • "pagination_info": {
    }
}

检索数据集的 Job

返回 Job

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

数据集 ID

job_id
必需
string <uuid> <= 36 个字符

Job ID

响应

响应示例

内容类型
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_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0"
}

删除数据集 Job

删除数据集 Job

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

数据集的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

获取数据集的 Job 日志

返回 job 日志

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

数据集 ID

job_id
必需
string <uuid> <= 36 个字符

Job ID

响应

响应示例

内容类型
text/plain
Execution status: PASS

取消数据集 Job

取消数据集 Job

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

数据集的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

下载 Job 工件

下载给定 job 生成的工件

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

dataset_id
必需
string <uuid> <= 36 个字符

数据集 ID

job_id
必需
string <uuid> <= 36 个字符

Job ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

EXPERIMENT

与 Experiment 相关的端点

列出 Experiments

返回 Experiments 列表

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

查询参数
skip
integer <int32> [ 0 .. 2147483647 ]

可选的跳过页码用于分页

size
integer <int32> [ 0 .. 2147483647 ]

可选的分页大小

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

可选的排序方式

name
string <= 5000 个字符 .*

可选的名称过滤器

type
string
Enum: "vision" "medical"

可选的类型过滤器

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"

可选的网络架构过滤器

read_only
boolean

可选的只读过滤器

user_only
boolean

可选过滤器，仅选择用户拥有的 experiment

tag
string <= 5000 个字符 .*

可选标签过滤器

响应

响应示例

内容类型
application/json
{
  • "experiments": [
    ],
  • "pagination_info": {
    }
}

创建新的 Experiment

返回新的 Experiment

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

请求体模式: application/json
必需

新 Experiment 的初始元数据 (需要 base_experiment 或 network_arch)

name
string <regex> <= 500 个字符
shared
boolean
user_id
string <uuid> <= 36 个字符
description
string <regex> <= 1000 个字符
model_description
string <regex> <= 1000 个字符
version
string <regex> <= 500 个字符
logo
string <url> <= 2048 个字符
ngc_path
string <regex> <= 250 个字符
workspace
string or null <uuid> <= 36 个字符
sha256_digest
object 或 null
base_experiment_pull_complete
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
additional_id_info
string 或 null <regex> <= 100 个字符
object
checkpoint_choose_method
string
Enum: "latest_model" "best_model" "from_epoch_number"
object
encryption_key
string <regex> <= 100 个字符
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 <uuid > <= 36 个字符 ]
eval_dataset
string <uuid> <= 36 个字符
inference_dataset
string <uuid> <= 36 个字符
calibration_dataset
string <uuid> <= 36 个字符
train_datasets
Array of strings <uuid> <= 9223372036854776000 项 [ items <uuid > <= 36 个字符 ]
read_only
boolean
public
boolean
object 或 null
metric
string 或 null <regex> <= 100 个字符
type
string
Enum: "vision" "medical"
realtime_infer
boolean
model_params
object 或 null
bundle_url
string 或 null <regex> <= 1000 个字符
realtime_infer_request_timeout
integer 或 null <int64> [ 0 .. 9223372036854776000 ]
Array of objects 或 null <= 9223372036854776000 项
tensorboard_enabled
boolean 或 null
tags
Array of strings <regex> <= 16 项 [ items <regex > <= 36 个字符 ]
retry_experiment_id
string or null <uuid> <= 36 个字符

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "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,
  • "experiment_actions": [
    ],
  • "tensorboard_enabled": true,
  • "tags": [
    ],
  • "retry_experiment_id": "9156f81c-d614-4eaa-af09-2507d8dc3481"
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "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": {
    },
  • "experiment_actions": [
    ],
  • "tensorboard_enabled": true,
  • "tags": [
    ]
}

列出可用于迁移学习的 Experiments

返回 NGC 公共目录和私有组织模型注册表中发布的模型列表

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

查询参数
skip
integer <int32> [ 0 .. 2147483647 ]

可选的跳过页码用于分页

size
integer <int32> [ 0 .. 2147483647 ]

可选的分页大小

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

可选的排序方式

name
string <= 5000 个字符 .*

可选的名称过滤器

type
string
Enum: "vision" "medical"

可选的类型过滤器

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"

可选的网络架构过滤器

read_only
boolean

可选的只读过滤器

响应

响应示例

内容类型
application/json
{
  • "experiments": [
    ],
  • "pagination_info": {
    }
}

检索 Experiment

返回 Experiment

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

要返回的 Experiment 的 ID

响应

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "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": {
    },
  • "experiment_actions": [
    ],
  • "tensorboard_enabled": true,
  • "tags": [
    ]
}

删除 Experiment

取消所有相关的正在运行的 job 并返回已删除的 Experiment

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

要删除的 Experiment 的 ID

响应

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "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": {
    },
  • "experiment_actions": [
    ],
  • "tensorboard_enabled": true,
  • "tags": [
    ]
}

更新 Experiment

返回更新后的 Experiment

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

要更新的 Experiment 的 ID

请求体模式: application/json
必需

Experiment 的更新元数据

name
string <regex> <= 500 个字符
shared
boolean
user_id
string <uuid> <= 36 个字符
description
string <regex> <= 1000 个字符
model_description
string <regex> <= 1000 个字符
version
string <regex> <= 500 个字符
logo
string <url> <= 2048 个字符
ngc_path
string <regex> <= 250 个字符
workspace
string or null <uuid> <= 36 个字符
sha256_digest
object 或 null
base_experiment_pull_complete
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
additional_id_info
string 或 null <regex> <= 100 个字符
object
checkpoint_choose_method
string
Enum: "latest_model" "best_model" "from_epoch_number"
object
encryption_key
string <regex> <= 100 个字符
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 <uuid > <= 36 个字符 ]
eval_dataset
string <uuid> <= 36 个字符
inference_dataset
string <uuid> <= 36 个字符
calibration_dataset
string <uuid> <= 36 个字符
train_datasets
Array of strings <uuid> <= 9223372036854776000 项 [ items <uuid > <= 36 个字符 ]
read_only
boolean
public
boolean
object 或 null
metric
string 或 null <regex> <= 100 个字符
type
string
Enum: "vision" "medical"
realtime_infer
boolean
model_params
object 或 null
bundle_url
string 或 null <regex> <= 1000 个字符
realtime_infer_request_timeout
integer 或 null <int64> [ 0 .. 9223372036854776000 ]
Array of objects 或 null <= 9223372036854776000 项
tensorboard_enabled
boolean 或 null
tags
Array of strings <regex> <= 16 项 [ items <regex > <= 36 个字符 ]
retry_experiment_id
string or null <uuid> <= 36 个字符

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "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,
  • "experiment_actions": [
    ],
  • "tensorboard_enabled": true,
  • "tags": [
    ],
  • "retry_experiment_id": "9156f81c-d614-4eaa-af09-2507d8dc3481"
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "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": {
    },
  • "experiment_actions": [
    ],
  • "tensorboard_enabled": true,
  • "tags": [
    ]
}

部分更新 Experiment

返回更新后的 Experiment

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

要更新的 Experiment 的 ID

请求体模式: application/json
必需

Experiment 的更新元数据

name
string <regex> <= 500 个字符
shared
boolean
user_id
string <uuid> <= 36 个字符
description
string <regex> <= 1000 个字符
model_description
string <regex> <= 1000 个字符
version
string <regex> <= 500 个字符
logo
string <url> <= 2048 个字符
ngc_path
string <regex> <= 250 个字符
workspace
string or null <uuid> <= 36 个字符
sha256_digest
object 或 null
base_experiment_pull_complete
string
Enum: "starting" "in_progress" "pull_complete" "invalid_pull"
additional_id_info
string 或 null <regex> <= 100 个字符
object
checkpoint_choose_method
string
Enum: "latest_model" "best_model" "from_epoch_number"
object
encryption_key
string <regex> <= 100 个字符
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 <uuid > <= 36 个字符 ]
eval_dataset
string <uuid> <= 36 个字符
inference_dataset
string <uuid> <= 36 个字符
calibration_dataset
string <uuid> <= 36 个字符
train_datasets
Array of strings <uuid> <= 9223372036854776000 项 [ items <uuid > <= 36 个字符 ]
read_only
boolean
public
boolean
object 或 null
metric
string 或 null <regex> <= 100 个字符
type
string
Enum: "vision" "medical"
realtime_infer
boolean
model_params
object 或 null
bundle_url
string 或 null <regex> <= 1000 个字符
realtime_infer_request_timeout
integer 或 null <int64> [ 0 .. 9223372036854776000 ]
Array of objects 或 null <= 9223372036854776000 项
tensorboard_enabled
boolean 或 null
tags
Array of strings <regex> <= 16 项 [ items <regex > <= 36 个字符 ]
retry_experiment_id
string or null <uuid> <= 36 个字符

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "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,
  • "experiment_actions": [
    ],
  • "tensorboard_enabled": true,
  • "tags": [
    ],
  • "retry_experiment_id": "9156f81c-d614-4eaa-af09-2507d8dc3481"
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "description": "/regex/",
  • "model_description": "/regex/",
  • "version": "/regex/",
  • "logo": "string",
  • "ngc_path": "/regex/",
  • "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89",
  • "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": {
    },
  • "experiment_actions": [
    ],
  • "tensorboard_enabled": true,
  • "tags": [
    ]
}

检索 Specs schema

返回给定操作的规格模式

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

action
必需
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"

操作名称

响应

响应示例

内容类型
application/json
{ }

检索基础 Experiment Specs schema

返回基础 experiment 的给定操作的 Specs schema

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

基础 Experiment 的 ID

action
必需
string
Enum: "train" "evaluate" "prune" "retrain" "export" "gen_trt_engine" "trtexec" "inference" "generate"

操作名称

响应

响应示例

内容类型
application/json
{ }

运行 Experiment Jobs

异步启动 Experiment 操作并返回相应的 Job ID

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

请求体模式: application/json
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"
parent_job_id
string or null <uuid> <= 36 个字符
name
string or null <regex> <= 500 个字符
description
string 或 null <regex> <= 1000 个字符
specs
any
platform_id
string or null <uuid> <= 36 个字符
num_gpu
integer 或 null <int64> [ 0 .. 9223372036854776000 ]

响应

请求示例

内容类型
application/json
{
  • "action": "dataset_convert",
  • "parent_job_id": "dd63d5e7-6727-402c-8127-3fd32aa9072a",
  • "name": "/regex/",
  • "description": "/regex/",
  • "specs": null,
  • "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  • "num_gpu": 9223372036854776000
}

响应示例

内容类型
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

列出 Experiment 的 Jobs

返回 Jobs 列表

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <= 36 个字符 .*

Experiment 的 ID

查询参数
skip
integer <int32> [ 0 .. 2147483647 ]

可选的跳过页码用于分页

size
integer <int32> [ 0 .. 2147483647 ]

可选的分页大小

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

可选的排序方式

响应

响应示例

内容类型
application/json
{
  • "jobs": [
    ],
  • "pagination_info": {
    }
}

获取此 job 存在的 epoch 编号

获取此 job 存在的检查点 epoch 编号

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

响应

响应示例

内容类型
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

将模型发布到 NGC

将模型发布到 NGC 私有注册表

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

请求体模式: application/json
team_name
string or null <regex> <= 500 个字符
display_name
string or null <regex> <= 500 个字符
description
string or null <regex> <= 500 个字符

响应

请求示例

内容类型
application/json
{
  • "team_name": "/regex/",
  • "display_name": "/regex/",
  • "description": "/regex/"
}

响应示例

内容类型
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

从 NGC 移除已发布模型

从 NGC 私有注册表移除模型

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

请求体模式: application/json
team_name
string or null <regex> <= 500 个字符
display_name
string or null <regex> <= 500 个字符
description
string or null <regex> <= 500 个字符

响应

请求示例

内容类型
application/json
{
  • "team_name": "/regex/",
  • "display_name": "/regex/",
  • "description": "/regex/"
}

响应示例

内容类型
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

检索 Experiment 的 Job

返回 Job

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job ID

响应

响应示例

内容类型
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_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  • "experiment_id": "916afd89-cac5-4339-9c59-dd068abdfa69"
}

删除 Experiment Job

删除 Experiment Job

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

获取 Experiment 的 Job 日志

返回 job 日志

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job ID

查询参数
automl_experiment_index
integer <int32> [ 0 .. 2147483647 ]

可选过滤器，用于从特定的 autoML experiment 检索日志

响应

响应示例

内容类型
text/plain
Execution status: PASS

检索可用的 AutoML 详细信息

检索可用的 AutoML 详细信息

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

暂停 Experiment Job - 仅用于训练

暂停 Experiment Job - 仅用于训练

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

取消 experiment 下的所有 Jobs

取消 experiment 下的所有 Jobs

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

取消 Experiment Job 或暂停训练

取消 Experiment Job 或暂停训练

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

恢复实验作业

恢复实验作业 - 仅训练/重新训练

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job 的 ID

请求体模式: application/json
可选

可调整的已恢复作业的元数据。

parent_job_id
string or null <uuid> <= 36 个字符
specs
任意或空值

响应

请求示例

内容类型
application/json
{
  • "parent_job_id": "dd63d5e7-6727-402c-8127-3fd32aa9072a",
  • "specs": null
}

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

下载作业工件

下载给定 job 生成的工件

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

experiment_id
必需
string <uuid> <= 36 个字符

Experiment 的 ID

job_id
必需
string <uuid> <= 36 个字符

Job ID

响应

响应示例

内容类型
application/json
{
  • "error_desc": "/regex/",
  • "error_code": -9223372036854776000
}

ORGS

检索部署期间基于后端的可用 GPU 类型

检索部署期间基于后端的可用 GPU 类型

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

响应

响应示例

内容类型
application/json
{ }

WORKSPACE

列出工作空间

返回工作空间列表

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

查询参数
skip
integer <int32> [ 0 .. 2147483647 ]

可选的跳过页码用于分页

size
integer <int32> [ 0 .. 2147483647 ]

可选的分页大小

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

可选的排序方式

name
string <= 5000 个字符 .*

可选的名称过滤器

format
string
枚举： "monai" "unet" "custom"

可选的格式过滤器

type
string
枚举： "object_detection" "semantic_segmentation" "image_classification"

可选的类型过滤器

响应

响应示例

内容类型
application/json
[
  • {
    }
]

创建新的工作空间

返回新的工作空间

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

请求体模式: application/json
必需

新工作空间的初始元数据（需要类型和格式）

name
string <regex> <= 500 个字符
shared
boolean
version
string <regex> <= 10 个字符
cloud_type
string
枚举： "aws" "azure" "gcp" "huggingface" "self_hosted"
cloud_specific_details
any

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "version": "/regex/",
  • "cloud_type": "aws",
  • "cloud_specific_details": null
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "version": "/regex/",
  • "cloud_type": "aws"
}

检索工作空间

返回工作空间

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

workspace_id
必需
string <uuid> <= 36 个字符

要返回的工作空间的 ID

响应

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "version": "/regex/",
  • "cloud_type": "aws"
}

删除工作空间

取消所有相关的正在运行的作业并返回已删除的工作空间

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

workspace_id
必需
string <uuid> <= 36 个字符

要删除的工作空间的 ID

响应

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "version": "/regex/",
  • "cloud_type": "aws"
}

更新工作空间

返回更新后的工作空间

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

workspace_id
必需
string <uuid> <= 36 个字符

要更新的工作空间的 ID

请求体模式: application/json
必需

工作空间的更新元数据

name
string <regex> <= 500 个字符
shared
boolean
version
string <regex> <= 10 个字符
cloud_type
string
枚举： "aws" "azure" "gcp" "huggingface" "self_hosted"
cloud_specific_details
any

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "version": "/regex/",
  • "cloud_type": "aws",
  • "cloud_specific_details": null
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "version": "/regex/",
  • "cloud_type": "aws"
}

部分更新工作空间

返回更新后的工作空间

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

workspace_id
必需
string <uuid> <= 36 个字符

要更新的工作空间的 ID

请求体模式: application/json
必需

工作空间的更新元数据

name
string <regex> <= 500 个字符
shared
boolean
version
string <regex> <= 10 个字符
cloud_type
string
枚举： "aws" "azure" "gcp" "huggingface" "self_hosted"
cloud_specific_details
any

响应

请求示例

内容类型
application/json
{
  • "name": "/regex/",
  • "shared": true,
  • "version": "/regex/",
  • "cloud_type": "aws",
  • "cloud_specific_details": null
}

响应示例

内容类型
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_on": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z",
  • "name": "/regex/",
  • "shared": true,
  • "version": "/regex/",
  • "cloud_type": "aws"
}

从工作空间检索数据集

返回与工作空间内请求正文参数匹配的数据集

授权
bearer-token
路径参数
org_name
必需
string <= 255 个字符 ^[a-zA-Z0-9_-]+$

组织名称

workspace_id
必需
string <uuid> <= 36 个字符

要返回的工作空间的 ID

响应

响应示例

内容类型
application/json
{
  • "dataset_paths": [
    ]
}