AI开发平台MODELARTS-更新训练作业参数:参数说明

时间:2023-11-17 18:34:54

参数说明

表1 Estimator请求参数说明

参数

是否必选

参数类型

描述

modelarts_session

Object

会话对象,初始化方法见Session鉴权

train_instance_count

Long

训练作业worker的个数。

code_dir

String

训练作业的代码目录,如“/bucket/src/”。当填入model_name时不需要填写。

boot_file

String

训练作业的代码启动文件,需要在代码目录下,如“/bucket/src/boot.py”。当填入model_name时不需要填写。

model_name

Long

训练作业的内置算法模型名称。填入model_name后app_url与boot_file_url不需填写,framework_type和framework_version也不需要填写。

output_path

String

训练作业的输出位置。

hyperparameters

JSON Array

训练作业的运行参数,为label-value格式;当为自定义镜像训练作业的时候,此参数为容器环境变量。

log_url

String

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

train_instance_type

Long

训练作业选择的资源规格。若选择在训练平台训练,请从查询资源规格列表接口获取。

framework_type

String

训练作业选择的引擎规格。请从查询引擎规格列表接口获取引擎规格。当填入model_name时不需要填写。

framework_version

String

训练作业选择的引擎版本。请从查询引擎规格列表接口获取引擎版本。当填入model_name时不需要填写。

job_description

String

训练作业的描述。

user_image_url

String

自定义镜像训练作业的自定义镜像的SWR-URL。如:“100.125.5.235:20202/jobmng/custom-cpu-base:1.0”

user_command

String

自定义镜像训练作业的自定义镜像的容器的启动命令。形式为:“bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}”

表2 update_job_configs请求参数说明

参数

是否必选

参数类型

描述

config_name

String

训练作业参数名称。限制为1-20位只含数字、字母、下划线或者中划线的名称。当不填写时,默认会按日期动态生成。

config_desc

String

对训练作业的描述,默认为空,字符串的长度限制为[0,256]。

inputs

String

训练作业的OBS数据存储位置。

dataset_id

String

训练作业的数据集ID。应与dataset_version_id同时出现,但不可与inputs同时出现。

dataset_version_id

String

训练作业的数据集版本ID。应与dataset_id同时出现,但不可与inputs同时出现。

data_source

JSON Array

训练作业使用的数据集。不可与inputs、dataset_id、dataset_version_id同时使用。

表3 data_source属性列表

参数

是否必选

参数类型

描述

dataset_id

String

训练作业的数据集ID。

dataset_version

String

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

type

String

数据集类型。可选值:“obs”“dataset”

data_url

String

obs的桶路径,不可与dataset_id/dataset_version同时出现。

表4 update_job_configs返回参数说明

参数

参数类型

描述

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

is_success

Boolean

接口调用是否成功。

support.huaweicloud.com/sdkreference-modelarts/modelarts_04_0178.html