更新时间:2023-12-14 GMT+08:00

查询训练作业版本详情

功能介绍

根据作业ID查看指定的训练作业详情。

URI

GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}

参数说明如表1所示。
表1 参数说明

参数

是否必选

参数类型

说明

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

job_id

Long

训练作业的ID。

version_id

Long

训练作业的版本ID。

请求消息

无请求参数。

响应消息

响应参数如表2所示。
表2 响应参数

参数

参数类型

说明

is_success

Boolean

请求是否成功。

job_id

Long

训练作业的ID。

job_name

String

训练作业的名称。

job_desc

String

训练作业的描述信息。

version_id

Long

训练作业的版本ID。

version_name

String

训练作业的版本名称。

pre_version_id

Long

训练作业前一版本的名称。

engine_type

integer

训练作业的引擎类型。“engine_type”“engine_name”对应关系如下:

  • engine_type:1,engine_name: "TensorFlow"
  • engine_type:2,engine_name: "MXNet"
  • engine_type:3,engine_name: "Ray"
  • engine_type:4,engine_name":"Caffe"
  • engine_type:5,engine_name: "Spark_MLlib"
  • engine_type:9,engine_name: "XGBoost-Sklearn"
  • engine_type:10,engine_name: "PyTorch"
  • engine_type:12,engine_name: "Horovod"

engine_name

String

训练作业的引擎名称。目前支持的引擎名称如下:

  • Ascend-Powered-Engine
  • Caffe
  • Horovod
  • MXNet
  • PyTorch
  • Ray
  • Spark_MLlib
  • TensorFlow
  • XGBoost-Sklearn
  • MindSpore-GPU

engine_id

Long

训练作业的引擎ID。

engine_version

String

训练作业使用的引擎版本。

status

Integer

训练作业的状态,详细作业状态列表请参见作业状态参考

app_url

String

训练作业的代码目录。

boot_file_url

String

训练作业的代码启动文件。

create_time

Long

训练作业的创建时间。

parameter

Array<Object>

训练作业的运行参数。当为自定义镜像训练作业的时候,此参数为容器环境变量。详细请参见表3

duration

Long

训练作业的运行时间,单位为毫秒。

spec_id

Long

训练作业资源规格ID。

core

String

资源规格的核数。

cpu

String

资源规格CPU内存。

gpu_num

Integer

资源规格gpu的个数。

gpu_type

String

资源规格gpu的类型。

worker_server_num

Integer

训练作业worker的个数。

data_url

String

训练作业的数据集。

train_url

String

训练作业输出文件OBS路径。

log_url

String

训练作业的日志OBS输出路径URL,默认为空。如:“/usr/train/”

dataset_version_id

String

训练作业的数据集版本ID。

dataset_id

String

训练作业的数据集ID。

data_source

Array<Object>

训练作业使用的多数据集。具体请参见表4

model_id

Long

训练作业的模型ID。

model_metric_list

String

训练作业的模型评测参数。具体请参见表5

system_metric_list

Object

训练作业的系统监控指标。具体请参见表6

user_image_url

String

自定义镜像训练作业的自定义镜像的SWR-URL。

user_command

String

自定义镜像训练作业的自定义镜像的容器的启动命令。

resource_id

String

训练作业的计费资源ID。

dataset_name

String

训练作业的数据集名称。

spec_code

String

训练作业资源规格。

start_time

Long

训练作业开始时间。

volumes

Array<Object>

训练作业可使用的存储卷。具体请参见表11

dataset_version_name

String

训练作业的数据集名称。

pool_name

String

资源池名称。

pool_id

String

资源池ID。

nas_mount_path

String

SFS Turbo (NAS) 训练本地挂载路径。如:“/home/work/nas”

nas_share_addr

String

SFS Turbo (NAS) 共享路径。如:“192.168.8.150:/”

nas_type

String

当前仅支持 nfs。如:“nfs”

表3 parameter属性列表

参数

参数类型

说明

label

String

参数名称。

value

String

参数值。

表4 data_source属性列表

参数

参数类型

说明

dataset_id

String

训练作业的数据集ID。

dataset_version

String

训练作业的数据集版本ID。

type

String

数据集类型。

  • “obs”:表示使用OBS的数据。
  • “dataset”:表示使用数据集的数据。

data_url

String

OBS的桶路径。

表5 model_metric_list属性列表

参数

参数类型

说明

metric

JSON Array

训练作业的模型单个分类测评参数。具体请参见表7

total_metric

JSON

训练作业的模型总测评参数。具体请参见表9

表6 system_metric_list属性列表

参数

参数类型

说明

cpuUsage

Array

训练作业CPU资源占用率。

memUsage

Array

训练作业内存资源占用率。

gpuUtil

Array

训练作业GPU资源占用率。

表7 metric属性列表

参数

参数类型

说明

metric_values

JSON

训练作业模型单个分类测评参数指标。具体请参见表8

reserved_data

JSON

预留字段。

metric_meta

JSON

训练作业模型单个分类,包含类ID和类名。

表8 metric_values属性列表

参数

参数类型

说明

recall

Float

训练作业模型单个分类召回率。

precision

Float

训练作业模型单个分类精确率。

accuracy

Float

训练作业模型单个分类准确率。

表9 total_metric属性列表

参数

类型

说明

total_metric_meta

JSON

预留字段。

total_reserved_data

JSON

预留字段。

total_metric_values

JSON

训练作业模型总测评参数指标。具体请参见表10

表10 total_metric_values属性列表

参数

参数类型

说明

f1_score

Float

训练作业模型总召回。

recall

Float

训练作业模型总召回率。

precision

Float

训练作业模型总精确率。

accuracy

Float

训练作业模型总准确率。

表11 volumes属性列表

参数

是否必选

参数类型

说明

nfs

Object

共享文件系统类型的存储卷。仅支持运行于已联通共享文件系统网络的资源池的训练作业。具体说明请参见表6

host_path

Object

主机文件系统类型的存储卷。仅支持运行于专属资源池中的训练作业。具体说明请参见表7

表12 nfs属性列表

参数

是否必选

参数类型

说明

id

String

SFS Turbo 文件系统 ID。

src_path

String

SFS Turbo 文件系统地址。

dest_path

String

训练作业的本地路径。

read_only

Boolean

dest_path 是否为只读权限,默认为读写权限。

  • true:只读权限
  • false:默认值,读写权限
表13 host_path属性列表

参数

是否必选

参数类型

说明

src_path

String

宿主机的本地路径。

dest_path

String

训练作业的本地路径。

read_only

Boolean

dest_path 是否为只读权限,默认为读写权限。

  • true:只读权限
  • false:默认值,读写权限

请求示例

如下以查询“job_id”为10,“version_id”为10的作业为例。

GET    https://endpoint/v1/{project_id}/training-jobs/10/versions/10

响应示例

  • 成功响应示例
    {
        "is_success": true,
        "job_id": 10,
        "job_name": "TestModelArtsJob",
        "job_desc": "TestModelArtsJob desc",
        "version_id": 10,
        "version_name": "jobVersion",
        "pre_version_id": 5,
        "engine_type": 1,
        "engine_name": "TensorFlow",
        "engine_id": 1,
        "engine_version": "TF-1.4.0-python2.7",
        "status": 10,
        "app_url": "/usr/app/",
        "boot_file_url": "/usr/app/boot.py",
        "create_time": 1524189990635,
        "parameter": [
            {
                "label": "learning_rate",
                "value": 0.01
            }
        ],
        "duration": 532003,
        "spec_id": 1,
        "core": 2,
        "cpu": 8,
        "gpu_num": 2,
        "gpu_type": "P100",
        "worker_server_num": 1,
        "data_url": "/usr/data/",
        "train_url": "/usr/train/",
        "log_url": "/usr/log/",
        "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90",
        "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24",
        "data_source": [
            {
                "type": "obs",
                "data_url": "/qianjiajun-test/minst/data/"
            }
        ],
        "user_image_url": "100.125.5.235:20202/jobmng/custom-cpu-base:1.0",
        "user_command": "bash -x /home/work/run_train.sh python /home/work/user-job-dir/app/mnist/mnist_softmax.py --data_url /home/work/user-job-dir/app/mnist_data",
        "model_id": 1,
        "model_metric_list": "{\"metric\":[{\"metric_values\":{\"recall\":0.005833,\"precision\":0.000178,\"accuracy\":0.000937},\"reserved_data\":{},\"metric_meta\":{\"class_name\":0,\"class_id\":0}}],\"total_metric\":{\"total_metric_meta\":{},\"total_reserved_data\":{},\"total_metric_values\":{\"recall\":0.005833,\"id\":0,\"precision\":0.000178,\"accuracy\":0.000937}}}",
        "system_metric_list": {
            "cpuUsage": [
                "0",
                "3.10",
                "5.76",
                "0",
                "0",
                "0",
                "0"
            ],
            "memUsage": [
                "0",
                "0.77",
                "2.09",
                "0",
                "0",
                "0",
                "0"
            ],
            "gpuUtil": [
                "0",
                "0.25",
                "0.88",
                "0",
                "0",
                "0",
                "0"
            ]
    },
        "dataset_name": "dataset-test",
        "dataset_version_name": "dataset-version-test",
        "spec_code": "modelarts.vm.gpu.p100",
        "start_time": 1563172362000,
        "volumes": [
            {
                "nfs": {
                    "id": "43b37236-9afa-4855-8174-32254b9562e7",
                    "src_path": "192.168.8.150:/",
                    "dest_path": "/home/work/nas",
                    "read_only": false
                }
            },
            {
                "host_path": {
                    "src_path": "/root/work",
                    "dest_path": "/home/mind",
                    "read_only": false
                }
            }
        ],
        "pool_id": "pool9928813f",
        "pool_name": "p100",
        "nas_mount_path": "/home/work/nas",
        "nas_share_addr": "192.168.8.150:/",
        "nas_type": "nfs"
    }
  • 失败响应示例
    {
        "is_success": false,
        "error_message": "Error string",
        "error_code": "ModelArts.0105"
    }

状态码

状态码请参见状态码