# 创建训练作业 - CreateTrainingJob #### 功能介绍 创建训练作业接口用于在ModelArts平台上启动新的训练任务。 该接口适用于以下场景：当用户需要基于特定的数据集和算法模型进行机器学习训练时，可以通过此接口创建并配置训练作业。使用该接口的前提条件是用户已上传数据集和模型代码至ModelArts平台，并具有创建训练作业的权限。创建训练作业后，平台将根据配置的资源规格启动训练任务，用户可以通过作业ID监控训练进度和状态。若数据集或模型代码不存在、资源规格配置错误或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=CreateTrainingJob)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:trainJob:logExport | Write | trainJob \* | - | - | - | #### URI POST /v2/{project_id}/training-jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：1 - 64字符，字母、数字和中划线。 **默认取值**：不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | kind | 是 | String | **参数解释**：训练作业类型。 **约束限制**：不涉及。 **取值范围**： - job：普通作业 - federated_pool_job：资源池联邦作业 - edge_job：边缘作业 - hetero_job：异构作业 - mrs_job：MRS作业 - autosearch_job：自动化搜索作业 - diag_job：诊断作业 - visualization_job：可视化作业 **默认取值**：job。 | | metadata | 是 | [JobMetadata] object | **参数解释**：训练作业元信息。 **约束限制**：不涉及。 | | algorithm | 否 | [JobAlgorithm] object | **参数解释**：训练作业算法。 **约束限制**：当tasks为空时该字段必填，有此字段时无需填写tasks字段。目前支持三种形式： - id：只取算法的id； - subscription_id+item_version_id：取算法的订阅id和版本id； - code_dir+boot_file：取训练作业的代码目录和启动文件。 | | tasks | 否 | Array of [Task] objects | **参数解释**：任务列表。 **约束限制**：当algorithm为空时该字段必填，有此字段时无需填写algorithm字段。该功能暂未实现。 | | spec | 否 | [Spec] object | **参数解释**：训练作业规格参数。 **约束限制**：当tasks为空时该字段必填，有此字段时无需填写tasks字段。 | | endpoints | 否 | [JobEndpointsReq] object | **参数解释**：远程接入训练作业时需要的相关配置。 **约束限制**：不涉及。 | | train_type | 否 | String | **参数解释**：训练作业类型。 **约束限制**：不涉及。 **取值范围**：SFT（全量微调）、PRETRAIN（预训练）、LORA（lora微调）、DPO（dpo强化学习）、RFT（rft强化学习）。 **默认取值**：不涉及。 | | ftjob_config | 否 | [MasJobConfig] object | **参数解释**：精调训练作业参数。 | 表3JobMetadata | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**：训练作业名称。 **约束限制**：不涉及。 **取值范围**：限制为1-128位只含数字、字母、下划线、中划线和中文的名称。 **默认取值**：不涉及。 | | workspace_id | 否 | String | **参数解释**：指定作业所处的工作空间。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：默认值为"0"。 | | description | 否 | String | **参数解释**：对训练作业的描述。 **约束限制**：不能包含字符\<和\> **取值范围**：长度限制为\[0, 512\]。 **默认取值**：默认为"NULL"。 | | annotations | 否 | Map\ | **参数解释**：训练作业高级功能配置。可选取值如下： - "job_template": "Template RL"（异构作业） - "fault-tolerance/job-retry-num": "3"（故障自动重启次数） - "fault-tolerance/job-unconditional-retry": "true"（无条件重启） - "fault-tolerance/hang-retry": "true"（卡死重启） - "jupyter-lab/enable": "true"（JupyterLab训练应用程序） - "tensorboard/enable": "true"（TensorBoard训练应用程序） - "mindstudio-insight/enable": "true"（MindStudio Insight训练应用程序） - "fault-tolerance/hccl_op_retry":"true"（算子重执行） - "performance_diagnosis_enabled":"true"（性能诊断功能） - "record/code-dir": "obs dir"（代码备份功能） **约束限制**：不涉及。 | | training_experiment_reference | 否 | [TrainingExperimentRequest] object | **参数解释**：训练实验参数。 **约束限制**：不涉及。 | 表4TrainingExperimentRequest | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**：实验ID，填写实验ID时，此训练作业将会纳入该已有实验分组。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | name | 否 | String | **参数解释**：实验名称，只填写实验名称时，将会创建该实验分组，并将此训练作业纳入该分组。 **约束限制**：只能由字母、数字、下划线、中划线和中文组成。 **取值范围**：最大长度128。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：描述信息。 **约束限制**：不能包含字符\<和\>。 **取值范围**：最大长度512。 **默认取值**：不涉及。 | 表5JobAlgorithm | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**：算法管理的算法id。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | name | 否 | String | **参数解释**：算法名称。 **约束限制**：无需填写。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | subscription_id | 否 | String | **参数解释**：订阅算法的订阅ID。 **约束限制**：应与item_version_id一同出现。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | item_version_id | 否 | String | **参数解释**：订阅算法的版本。 **约束限制**：应与subscription_id一同出现。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | code_dir | 否 | String | **参数解释**：训练作业的代码目录。如："/usr/app/"。 **约束限制**：应与boot_file一同出现，如果boot_file填入id或subscription_id+item_version_id，则此参数无需填写。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | boot_file | 否 | String | **参数解释**：训练作业的代码启动文件，需要在代码目录下。如："/usr/app/boot.py"。 **约束限制**：应与code_dir一同出现，如果code_dir填入id或subscription_id+item_version_id，则此参数无需填写。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | autosearch_config_path | 否 | String | **参数解释**：自动化搜索作业的yaml配置路径，需要提供一个OBS路径。如："obs://bucket/file.yaml"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | autosearch_framework_path | 否 | String | **参数解释**：自动化搜索作业的框架代码目录，需要提供一个OBS路径。如："obs://bucket/files/"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | command | 否 | String | **参数解释**：自定义镜像场景下，训练作业的自定义镜像的容器的启动命令。例如python train.py。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | parameters | 否 | Array of [Parameters] objects | **参数解释**：训练作业的运行参数。 **约束限制**：不涉及。 | | policies | 否 | [JobPolicies] object | **参数解释**：作业支持的策略，用于超参搜索。 **约束限制**：不涉及。 | | inputs | 否 | Array of [Input] objects | **参数解释**：训练作业的数据输入。 **约束限制**：不涉及。 | | outputs | 否 | Array of [Output] objects | **参数解释**：训练作业的结果输出。 **约束限制**：不涉及。 | | engine | 否 | [JobEngine] object | **参数解释**：训练作业的引擎。 **约束限制**：使用算法管理的算法id或订阅算法subscription_id+item_version_id创建作业时，无需填写。 | | local_code_dir | 否 | String | **参数解释**：算法的代码目录下载到训练容器内的本地路径。 **约束限制**： - 必须为/home下的目录。 - v1兼容模式下，当前字段不生效。 - 当code_dir以file://为前缀时，当前字段不生效。 - 不支持配置成/home/ma-user/modelarts，/home/ma-user/modelarts-dev，/home/ma-user/infer以及它们底下的目录，也不支持配置成/home/ma-user **取值范围**：不涉及。 **默认取值**：不涉及。 | | working_dir | 否 | String | **参数解释**：运行算法时所在的工作目录。 **约束限制**：v1兼容模式下，当前字段不生效。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | environments | 否 | Map\ | **参数解释**：训练作业的环境变量。格式："key":"value"。其中key最大允许填写8192字符，value最大允许填写4096字符，最多允许100对环境变量。变量名应该仅包含字母、数字、下划线，且以字母或下划线开头。 **约束限制**：不支持使用符号 $ 引用变量。 | | summary | 否 | [Summary] object | **参数解释**：可视化日志summary。 **约束限制**：不涉及。 | 表6Parameters | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**：参数名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | value | 否 | String | **参数解释**：参数值。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：参数描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | constraint | 否 | [ParametersConstraint] object | **参数解释**：参数属性。 **约束限制**：不涉及。 | | i18n_description | 否 | [I18nDescription] object | **参数解释**：国际化描述。 **约束限制**：不涉及。 | 表7ParametersConstraint | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | **参数解释**：参数种类。 **约束限制**：不涉及。 **取值范围**：枚举值如下： - Integer：整数 - Float：浮点数 - String：字符串 - Boolean：布尔值 **默认取值**：不涉及。 | | editable | 否 | Boolean | **参数解释**：是否可编辑。 **约束限制**：不涉及。 **取值范围**： - true：可编辑 - false：不可编辑 **默认取值**：不涉及。 | | required | 否 | Boolean | **参数解释**：是否必须。 **约束限制**：不涉及。 **取值范围**： - true：必须 - false：非必须 **默认取值**：不涉及。 | | sensitive | 否 | Boolean | **参数解释**：是否敏感。 **约束限制**：该功能暂未实现。 **取值范围**： - true：敏感 - false：不敏感 **默认取值**：不涉及。 | | valid_type | 否 | String | **参数解释**：有效种类。 **约束限制**：不涉及。 **取值范围**：枚举值如下： - Choice：枚举值 - Range：范围值 - None：无 **默认取值**：不涉及。 | | valid_range | 否 | Array of strings | **参数解释**：有效范围。 **约束限制**：不涉及。 | 表8I18nDescription | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | language | 否 | String | **参数解释**：国际语种。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表9JobPolicies | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | auto_search | 否 | [AutoSearch] object | **参数解释**：超参搜索配置。 **约束限制**：不涉及。 | 表10AutoSearch | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | skip_search_params | 否 | String | **参数解释**：需要排除的超参组合。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | reward_attrs | 否 | Array of [RewardAttrs] objects | **参数解释**：搜索指标列表。 **约束限制**：不涉及。 | | search_params | 否 | Array of [SearchParams] objects | **参数解释**：搜索参数。 **约束限制**：不涉及。 | | algo_configs | 否 | Array of [AlgoConfigs] objects | **参数解释**：搜索算法配置。 **约束限制**：不涉及。 | 表11RewardAttrs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**：指标名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | mode | 否 | String | **参数解释**：搜索方向。 **约束限制**：不涉及。 **取值范围**： - max：表示指标值越大越好 - min：表示指标值越小越好 **默认取值**：不涉及。 | | regex | 否 | String | **参数解释**：指标正则表达式。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表12SearchParams | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**：超参名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | param_type | 否 | String | **参数解释**：参数类型。 **约束限制**：不涉及。 **取值范围**： - continuous：表示这个超参是连续类型的。连续类型的超参在算法使用于训练作业时，控制台显示为输入框 - discrete：表示这个超参是离散类型的。离散类型的超参在算法使用于训练作业时，控制台显示为下拉选择框架 **默认取值**：不涉及。 | | lower_bound | 否 | String | **参数解释**：超参下界。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | upper_bound | 否 | String | **参数解释**：超参上界。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | discrete_points_num | 否 | String | **参数解释**：连续型超参离散化取值个数。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | discrete_values | 否 | Array of strings | **参数解释**：离散型超参的取值列表。 **约束限制**：不涉及。 | 表13AlgoConfigs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**：搜索算法名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | params | 否 | Array of [AutoSearchAlgoConfigParameter] objects | **参数解释**：搜索算法参数。 **约束限制**：不涉及。 | 表14AutoSearchAlgoConfigParameter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | **参数解释**：参数键。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | value | 否 | String | **参数解释**：参数值。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | type | 否 | String | **参数解释**：参数种类。 **约束限制**：不涉及。 **取值范围**：枚举值如下： - Float：浮点数 - Integer：整数 - String：字符串 **默认取值**：不涉及。 | 表15JobEngine | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine_id | 否 | String | **参数解释**：训练作业选择的引擎规格ID。 **约束限制**：engine_id，engine_name+engine_version和image_url方式三选一。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | engine_name | 否 | String | **参数解释**：训练作业选择的引擎规格名称。 **约束限制**：如果已填写engine_id，则此参数无需填写。如果使用预置框架+自定义镜像的创建方式时需要同时传入此参数和image_url参数。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | engine_version | 否 | String | **参数解释**：训练作业选择的引擎规格版本。 **约束限制**：如果已填写engine_id，则此参数无需填写。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | image_url | 否 | String | **参数解释**：训练作业选择的自定义镜像地址，地址从swr服务获取。 **约束限制**：不涉及。 **取值范围**：格式：组织名/镜像名:版本号。 **默认取值**：不涉及。 | | install_sys_packages | 否 | Boolean | **参数解释**：是否需要安装训练平台指定的 moxing 版本。 **约束限制**：只有填写了engine_name，engine_version，image_url参数时支持该设置。 **取值范围**： - true：需要 - false：不需要 **默认取值**：不涉及。 | | image_repo_id | 否 | String | **参数解释**：SWR企业仓实例ID，使用企业仓自定义镜像时需传入。 **约束限制**： - 仅当使用企业仓自定义镜像时需填写，即image_url指向企业仓镜像时必传。 - 不填写时，image_url视为普通自定义镜像（共享SWR）。 - 传入后系统会校验企业仓镜像的访问权限及镜像是否存在。 **取值范围**：合法的SWR企业仓实例ID。 **默认取值**：不涉及。 | 表16Summary | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | log_type | 否 | String | **参数解释**：训练作业可视化日志类型，配置后训练作业可作为可视化作业数据源。 **约束限制**：不涉及。 **取值范围**： - tensorboard：输出TensorBoard可视化工具类型的日志 - mindstudio-insight：输出mindstudio-insight可视化工具类型的日志 **默认取值**：不涉及。 | | log_dir | 否 | [LogDir] object | **参数解释**：训练作业可视化日志输出。 **约束限制**：log_type非空时必填。 | | data_sources | 否 | Array of [DataSource] objects | **参数解释**：可视化作业或训练作业调试模式的可视化日志输入。 **约束限制**：训练作业高级功能开启"tensorboard/enable": "true"或"mindstudio-insight/enable": "true"时必填。 | 表17LogDir | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pfs | 是 | [PFSSummary] object | **参数解释**：OBS并行文件系统可视化日志输出。 **约束限制**：不涉及。 | 表18PFSSummary | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pfs_path | 是 | String | **参数解释**：obs并行文件系统路径url，如："/example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表19DataSource | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job | 是 | [JobSummary] object | **参数解释**：作业数据源。 **约束限制**：可视化作业或训练作业调试模式的可视化日志输入，填之前确保开启"tensorboard/enable": "true"或"mindstudio-insight/enable": "true"。 | | nfs | 否 | [NFSSummary] object | **参数解释**：sfsTurbo弹性文件系统数据源。 **约束限制**：填之前确保高级功能开启"mindstudio-insight/enable":"true"或"tensorboard/enable": "true"。 | 表20JobSummary | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job_id | 是 | String | **参数解释**：训练作业id。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表21NFSSummary | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | nfs_path | 是 | String | **参数解释**：sfsTurbo弹性文件系统url，如"140f956f-c31-\*\*\*\*\*.sfsturbo.internal:/"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表22Task | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | role | 否 | String | **参数解释**：任务角色。 **约束限制**：该功能暂未支持。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | algorithm | 否 | [algorithm] object | **参数解释**：算法管理算法配置。 **约束限制**：不涉及。 | | task_resource | 否 | [task_resource] object | **参数解释**：训练作业资源规格信息。 **约束限制**：不涉及。 | | log_export_path | 否 | [log_export_path] object | **参数解释**：训练作业日志保存信息。 **约束限制**：不涉及。 | 表23algorithm | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | job_config | 否 | [job_config] object | **参数解释**：算法配置信息，如启动文件等。 **约束限制**：不涉及。 | | code_dir | 否 | String | **参数解释**：算法的代码目录。如："/usr/app/"。 **约束限制**：应与boot_file一同出现。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | boot_file | 否 | String | **参数解释**：算法的代码启动文件，需要在代码目录下。如："/usr/app/boot.py"。 **约束限制**：应与code_dir一同出现。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | engine | 否 | [engine] object | **参数解释**：异构作业算法的引擎。 **约束限制**：不涉及。 | | inputs | 否 | Array of [inputs] objects | **参数解释**：算法的数据输入。 **约束限制**：不涉及。 | | outputs | 否 | Array of [outputs] objects | **参数解释**：算法的数据输出。 **约束限制**：不涉及。 | | local_code_dir | 否 | String | **参数解释**：算法的代码目录下载到训练容器内的本地路径。 **约束限制**： - 必须为/home下的目录； - v1兼容模式下，当前字段不生效； - 当code_dir以file://为前缀时，当前字段不生效。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | working_dir | 否 | String | **参数解释**：运行算法时所在的工作目录。 **约束限制**：v1兼容模式下，当前字段不生效。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | environments | 否 | Map\ | **参数解释**：训练作业环境变量。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表24job_config | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | parameters | 否 | Array of [Parameter] objects | **参数解释**：算法的运行参数。 **约束限制**：不涉及。 | | inputs | 否 | Array of [Input] objects | **参数解释**：算法的数据输入。 **约束限制**：不涉及。 | | outputs | 否 | Array of [Output] objects | **参数解释**：算法的数据输出。 **约束限制**：不涉及。 | | engine | 否 | [engine] object | **参数解释**：算法的引擎。 **约束限制**：不涉及。 | 表25Parameter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**：参数名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | value | 否 | String | **参数解释**：参数值。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：参数描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | constraint | 否 | [constraint] object | **参数解释**：参数属性。 **约束限制**：不涉及。 | | i18n_description | 否 | [i18n_description] object | **参数解释**：国际化描述。 **约束限制**：不涉及。 | 表26constraint | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | **参数解释**：参数种类。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | editable | 否 | Boolean | **参数解释**：是否可编辑。 **约束限制**：不涉及。 **取值范围**： - true：可编辑 - false：不可编辑 **默认取值**：不涉及。 | | required | 否 | Boolean | **参数解释**：是否必须。 **约束限制**：不涉及。 **取值范围**： - true：必须 - false：非必须 **默认取值**：不涉及。 | | sensitive | 否 | Boolean | **参数解释**：是否敏感。 **约束限制**：该功能暂未实现。 **取值范围**： - true：敏感 - false：不敏感 **默认取值**：不涉及。 | | valid_type | 否 | String | **参数解释**：有效种类。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | valid_range | 否 | Array of strings | **参数解释**：有效范围。 **约束限制**：不涉及。 | 表27i18n_description | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | language | 否 | String | **参数解释**：国际语种。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：国际化语种的描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表28Input | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**：数据输入通道名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：数据输入通道描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | local_dir | 否 | String | **参数解释**：数据输入通道映射的容器本地路径。例如，"/home/ma-user/modelarts/inputs/data_url_0"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | access_method | 否 | String | **参数解释**：数据输入通道路径（local_dir）的下发方式。 **约束限制**：不涉及。 **取值范围**： - parameter：超参形式 - env：环境变量形式 **默认取值**：默认超参形式。 | | remote | 是 | [InputDataInfo] object | **参数解释**：数据实际输入信息。枚举值： - dataset：指定输入为数据集； - obs：指定输入为OBS路径。 **约束限制**：不涉及。 | | remote_constraint | 否 | Array of [remote_constraint] objects | **参数解释**：数据输入约束。 **约束限制**：不涉及。 | 表29remote_constraint | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | data_type | 否 | String | **参数解释**：数据输入类型，包括数据存储位置、数据集两种方式，其中数据集功能即将下线。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | attributes | 否 | String | **参数解释**：相关属性。 **约束限制**：不涉及。 **取值范围**： 数据输入为数据集时： - data_format：数据格式 - data_segmentation：数据切分方式 - dataset_type：标注类型 **默认取值**：不涉及。 | 表30Output | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**：数据输出通道名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：数据输出通道描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | local_dir | 否 | String | **参数解释**：数据输出通道映射的容器本地路径。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | access_method | 否 | String | **参数解释**：数据输出通道路径（local_dir）的下发方式。 **约束限制**：不涉及。 **取值范围**： - parameter：超参形式 - env：环境变量形式 **默认取值**：默认超参形式。 | | remote | 是 | [Remote] object | **参数解释**：数据实际输出信息。 **约束限制**：不涉及。 | 表31Remote | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs | 是 | [RemoteObs] object | **参数解释**：数据实际输出到OBS。 **约束限制**：不涉及。 | 表32RemoteObs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs_url | 是 | String | **参数解释**：数据实际输出到OBS的路径，如："obs://example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表33engine | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine_id | 否 | String | **参数解释**：算法选择的引擎规格ID。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | engine_name | 否 | String | **参数解释**：算法选择的引擎规格名称。 **约束限制**：若填入engine_id则无需填写。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | engine_version | 否 | String | **参数解释**：算法选择的引擎规格版本。 **约束限制**：若填入engine_id则无需填写。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | image_url | 否 | String | **参数解释**：算法选择的自定义镜像地址，如"train-image/pytorch_2_1_xxx:1.0.1"，地址从SWR服务获取。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | run_user | 否 | String | **参数解释**：容器镜像启动用户。 **约束限制**：仅自定义镜像场景下支持配置。 **取值范围**：不涉及。 **默认取值**：1000。 | 表34engine | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine_id | 否 | String | **参数解释**：异构作业引擎规格的ID。如"caffe-1.0.0-python2.7"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | engine_name | 否 | String | **参数解释**：异构作业引擎规格的名称。如"Caffe"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | engine_version | 否 | String | **参数解释**：异构作业引擎规格的版本。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | image_url | 否 | String | **参数解释**：算法选择的自定义镜像地址。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | run_user | 否 | String | **参数解释**：容器镜像启动用户。 **约束限制**：仅自定义镜像场景下支持配置。 **取值范围**：不涉及。 **默认取值**：1000。 | 表35inputs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**：数据输入通道名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：数据输入通道描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | local_dir | 否 | String | **参数解释**：数据输入通道映射的容器本地路径。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | remote | 是 | [InputDataInfo] object | **参数解释**：数据实际输入信息。枚举值： - dataset：指定输入为数据集； - obs：指定输入为OBS路径。 **约束限制**：不涉及。 | 表36InputDataInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | dataset | 否 | [dataset] object | **参数解释**：数据输入信息为数据集，兼容新版数据集和旧版数据集功能，其中旧版数据集功能即将下线，推荐使用新版数据集。 **约束限制**：不涉及。 | | obs | 否 | [obs] object | **参数解释**：数据输入输出信息为OBS方式。 **约束限制**：不涉及。 | 表37dataset | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释**：训练作业的数据集ID。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | version_id | 否 | String | **参数解释**：训练作业的数据集版本ID。 **约束限制**：使用旧版数据集即service_type不为V3时必填。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | obs_url | 否 | String | **参数解释**：训练作业需要的数据集OBS路径URL，ModelArts会通过数据集ID和数据集版本ID自动解析生成。如："/usr/data/"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | service_type | 否 | String | **参数解释**：数据集服务类型。 **约束限制**：不涉及。 **取值范围**：取值为V4时标识使用新版数据集资产，取值为V3时表示使用v3老数据集，否则为v2老数据集，无特殊情况使用V4。 **默认取值**：不涉及。 | | name | 否 | String | **参数解释**：训练作业的数据集名称。 **约束限制**：使用新版数据集必填。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | dataset_proportion | 否 | Integer | **参数解释**：精调训练作业的数据集配比比率，表示使用多少百分比的该数据集进行训练。 **约束限制**：仅新版数据集支持。 **取值范围**：0\~100。 **默认取值**：不涉及。 | 表38obs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs_url | 是 | String | **参数解释**：训练作业需要的数据集OBS路径URL。如："obs://example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表39outputs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**：数据输出通道名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | description | 否 | String | **参数解释**：数据输出通道描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | local_dir | 否 | String | **参数解释**：数据输出通道映射的容器本地路径。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | remote | 是 | [remote] object | **参数解释**：数据实际输出信息。 **约束限制**：不涉及。 | 表40remote | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs | 是 | [obs] object | **参数解释**：数据实际输出到OBS。 **约束限制**：不涉及。 | 表41obs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs_url | 是 | String | **参数解释**：数据实际输出到OBS的路径。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表42task_resource | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | flavor_id | 否 | String | **参数解释**：训练作业选择的资源规格ID。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | node_count | 是 | Integer | **参数解释**：训练作业选择的资源副本数。 **约束限制**：不涉及。 **取值范围**：大于等于1。 **默认取值**：不涉及。 | | pool_id | 否 | String | **参数解释**：训练任务选择的资源池ID。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表43log_export_path | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs_url | 否 | String | **参数解释**：训练作业日志保存OBS路径，如："obs://example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表44Spec | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | resource | 否 | [SpecResource] object | **参数解释**：训练作业资源规格信息。 **约束限制**：flavor_id和pool_id+\[flavor_id\]方式二选一。 - 选择公共资源池时，仅上送flavor_id，选择训练作业需要的卡数、内存等资源规格，当公共资源池空闲资源满足选择的规格需求时，作业可被调度； - 选择专属资源池时，需上送pool_id与flavor_id，选择专属资源池下可选的实际规格，即满足训练作业条件的最小卡数，以便节省专属资源，提高利用率。 | | volumes | 否 | Array of [SpecVolumes] objects | **参数解释**：训练作业挂载卷信息。 **约束限制**：不涉及。 | | log_export_path | 否 | [LogExportPath] object | **参数解释**：训练作业日志输出信息。 **约束限制**：不涉及。 | | auto_stop | 否 | [AutoStop] object | **参数解释**：训练作业的自动停止配置。 **约束限制**：不涉及。 | | retention | 否 | [RetentionPolicy] object | **参数解释**：作业级库记录自动老化配置。 **约束限制**：仅在创建作业时指定，创建后不可修改。 **取值范围**：不涉及。 **默认取值**：不传表示未单独设置。 | | schedule_policy | 否 | [SchedulePolicy] object | **参数解释**：训练作业调度策略。 **约束限制**：不涉及。 | | log_export_config | 否 | [LogExportConfig] object | **参数解释**：日志导出配置。 **约束限制**：不涉及。 | | notification | 否 | [Notification] object | **参数解释**：训练事件的消息通知。 **约束限制**：不涉及。 | | custom_metrics | 否 | Array of [CustomMetrics] objects | **参数解释**：指标采集配置。 | | output_model | 否 | [OutputModel] object | **参数解释**：自定义训练作业产物输出信息。 | | asset_model | 否 | [AssetModel] object | **参数解释**：自定义训练作业产物发布成模型的信息。 | | asset_id | 否 | String | **参数解释**：精调训练作业资产模型ID。 | | reserved_time | 否 | [ReserveTime] object | **参数解释**：训练作业的保留时长配置。 **约束限制**：不涉及。 | 表45SpecResource | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | flavor_id | 否 | String | **参数解释**：训练作业资源规格id。 **约束限制**：CPU规格专属资源池不支持指定flavor_id。 **取值范围**：GPU/Ascend规格专属资源池可选取值如下： - modelarts.pool.visual.xlarge（1卡） - modelarts.pool.visual.2xlarge（2卡） - modelarts.pool.visual.4xlarge（4卡） - modelarts.pool.visual.8xlarge（8卡） - modelarts.pool.visual.16xlarge（16卡，当前仅限Snt9b23超节点资源池） **默认取值**：不涉及。 | | node_count | 是 | Integer | **参数解释**：资源池创建训练作业使用节点数。 **约束限制**：不涉及。 **取值范围**：大于等于1。 **默认取值**：不涉及。 | | pool_id | 否 | String | **参数解释**：专属资源池id。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | pool_group_id | 否 | String | **参数解释**：资源池联邦id。 **约束限制**：当kind为federated_pool_job时，该字段必填。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | main_container_customized_flavor | 否 | [MainContainerCustomizedFlavor] object | **参数解释**：自定义规格。 **约束限制**：cpu核数与内存大于零，加速卡卡数大于等于零。 | 表46MainContainerCustomizedFlavor | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | cpu_core_num | 否 | Float | **参数解释**：cpu核数。 **取值范围**：大于零。 **约束限制**：不涉及。 **默认取值**：不涉及。 | | mem_size | 否 | Float | **参数解释**：内存大小，单位GB。 **取值范围**：大于零。 **约束限制**：不涉及。 **默认取值**：不涉及。 | | accelerator_num | 否 | Float | **参数解释**：加速卡卡数。 **取值范围**：大于等于零。 **约束限制**：不涉及。 **默认取值**：不涉及。 | 表47SpecVolumes | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | nfs | 否 | [Nfs] object | **参数解释**：训练作业nfs挂载卷信息。 **约束限制**：不涉及。 | | pfs | 否 | [Pfs] object | **参数解释**：训练作业obsfs挂载卷信息。 **约束限制**：不涉及。 | | obs | 否 | [Obs] object | **参数解释**：训练作业obs挂载卷信息。 **约束限制**：不涉及。 | 表48Nfs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | nfs_server_path | 否 | String | **参数解释**：nfs服务端路径，如："10.10.10.10:/example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | local_path | 否 | String | **参数解释**：挂载到训练容器中的路径，如："/example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | read_only | 否 | Boolean | **参数解释**：nfs挂载卷在容器中是否只读。 **约束限制**：不涉及。 **取值范围**： - true：只读 - false：非只读 **默认取值**：不涉及。 | 表49Pfs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pfs_path | 否 | String | **参数解释**：obsfs的地址。如："/test-bucket/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | local_path | 否 | String | **参数解释**：挂载到训练容器中的路径，如："/example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表50Obs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs_path | 否 | String | **参数解释**：需要挂载的obs路径。如："/test-bucket/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | local_path | 否 | String | **参数解释**：挂载到训练容器中的路径，如："/example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表51LogExportPath | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs_url | 否 | String | **参数解释**：训练作业日志保存的OBS地址，如："obs://example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | host_path | 否 | String | **参数解释**：训练作业日志保存的宿主机的路径，如："/example/path"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表52AutoStop | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | time_unit | 是 | String | **参数解释**：时间单位。 **约束限制**：不涉及。 **取值范围**： - HOURS：小时 - MINUTES：分钟 **默认取值**：不涉及。 | | duration | 是 | Integer | **参数解释**：运行时长。 **约束限制**：不涉及。 **取值范围**：最小值为1，若time_unit为HOURS，最小时长为1小时。 **默认取值**：不涉及。 | 表53RetentionPolicy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | policy | 否 | String | **参数解释**：作业级库记录自动老化策略。 **约束限制**： - 仅当平台开启作业老化能力且作业类型为自定义训练作业（kind=job）时生效； - 与用户级「作业自动老化」开关联动： - 用户级开关**开启** ：该用户下所有作业均参与老化（*policy=disabled* 不能单独豁免）； - 用户级开关**关闭** ：仅 *policy=enabled* 的作业参与老化；未设置或 *disabled* 均不参与。 **取值范围**： - enabled：开启本作业老化 - disabled：关闭本作业老化（仅在用户级开关关闭时有效） **默认取值**：不传表示未单独设置，跟随用户级开关策略。 | 表54SchedulePolicy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | required_affinity | 否 | [RequiredAffinity] object | **参数解释**：训练作业强制的亲和性。 **约束限制**：不涉及。 | | preferred_affinity | 否 | [PreferredAffinity] object | **参数解释**：训练作业首选的亲和性。 **约束限制**：不涉及。 | | priority | 否 | Integer | **参数解释**：训练作业优先级。 **约束限制**： - 仅使用专属资源池训练时才支持设置训练作业优先级。 - 作业优先级取值为1\~3，默认优先级为1，最高优先级为3。 默认用户权限可选择优先级1和2，配置了"设置作业为高优先级权限"的用户可选择优先级1\~3。 **取值范围**：0-3 **默认取值**：不涉及。 | | preemptible | 否 | Boolean | **参数解释**：是否可以被抢占。 **约束限制**：不涉及。 **取值范围**： - true：可以被抢占 - false：不可以被抢占 **默认取值**：不涉及。 | 表55RequiredAffinity | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | affinity_type | 否 | String | **参数解释**：亲和调度策略。 **约束限制**：如果亲和调度策略为hyperinstance，则资源池必须为超节点资源池，否则无法进行调度。 **取值范围**： - cabinet：强整柜调度 - hyperinstance：超节点亲和调度 - networkTopology: 网络拓扑亲和调度 **默认取值**：不涉及。 | | job_level | 否 | String | **参数解释**：作业整体的网络拓扑约束。 **约束限制**：affinity_type为networkTopology时有效，系统会将作业的所有task调度至不高于job_level层的节点组中。 用户向超节点资源池投递训练作业，如果未设置作业整体的网络拓扑约束，系统会默认赋值为cluster。 **取值范围**： - cluster：资源池级 - hyperinstanceGroup: 超节点级 **默认取值**：默认值cluster。 | | affinity_group_size | 否 | Integer | **参数解释**：亲和组大小。 **约束限制**：affinity_type为hyperinstance或networkTopology时必填，系统会将affinity_group_size个task调度到一个超节点内组成亲和组。affinity_group_size的大小不能超过超节点的步长。 用户向超节点资源池投递训练作业，如果未设置亲和组大小，系统会默认赋值为1。 **取值范围**：不涉及。 **默认取值**：默认值1。 | | affinity_group_level | 否 | String | **参数解释**：亲和组的网络拓扑约束。 **约束限制**：affinity_type为networkTopology时有效，系统会将affinity_group_size个task组成的亲和组调度至不高于affinity_group_level层的节点组中。 用户向超节点资源池投递训练作业，如果未设置亲和组的网络拓扑约束，系统会默认赋值为hyperinstanceGroup。 **取值范围**： - hyperinstance：超节点级 - slice: 柜级 **默认取值**：默认值hyperinstanceGroup。 | | node_affinity | 否 | [NodeSelector] object | **参数解释**：节点亲和性。 **约束限制**：不涉及。 | 表56NodeSelector | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | nodeSelectorTerms | 是 | Array of [NodeSelectorTerm] objects | **参数解释**：节点选择器项的列表。这些项是"或"的关系。 **约束限制**：不涉及。 | 表57NodeSelectorTerm | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | matchExpressions | 否 | Array of [NodeSelectorRequirement] objects | **参数解释**：按节点标签列出的节点选择器要求。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | matchFields | 否 | Array of [NodeSelectorRequirement] objects | **参数解释**：按节点字段列出的节点选择器要求。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表58PreferredAffinity | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | node_affinity | 否 | Array of [PreferredSchedulingTerm] objects | **参数解释**：调度器会优先将Pod调度到满足该字段指定的亲和性表达式的节点上，但它也可能选择违反一个或多个表达式的节点。最优先选择的节点是权重总和最大的节点，即对于每个满足所有调度要求（资源请求、调度期间必需的亲和性表达式等）的节点，通过遍历该字段的元素并计算总和，如果节点匹配相应的匹配表达式，则将"权重"加到总和中；权重总和最高的节点即为最优先选择的节点。 **约束限制**：不涉及。 | 表59PreferredSchedulingTerm | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | weight | 否 | Integer | **参数解释**：与匹配相应 nodeSelectorTerm 相关的权重。 **约束限制**：不涉及。 **取值范围**：范围为 1-100。 **默认取值**：不涉及。 | | preference | 否 | [NodeSelectorTerm] object | **参数解释**：节点选择器项，与相应的权重相关联。 **约束限制**：不涉及。 | 表60NodeSelectorRequirement | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释**：选择器应用的标签键。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | operator | 是 | String | **参数解释**：表示键与一组值之间的关系。 **约束限制**：不涉及。 **取值范围**： - In：表示键的值必须在给定的值列表中。例如，如果键是 color，值列表是 \["red", "blue"\]，那么 color In \["red", "blue"\] 表示 color 的值必须是 red 或 blue。 - NotIn：表示键的值不能在给定的值列表中。例如，color NotIn \["red", "blue"\] 表示 color 的值不能是 red 或 blue。 - Exists：表示键必须存在，但对其值没有特定要求。例如，color Exists 表示必须存在 color 这个键，无论其值是什么。 - DoesNotExist：表示键不能存在。例如，color DoesNotExist 表示不能存在 color 这个键。 - Gt：表示键的值必须大于给定的值。例如，如果键是 age，age Gt 18 表示 age 的值必须大于 18。 - Lt：表示键的值必须小于给定的值。例如，age Lt 18 表示 age 的值必须小于 18。 **默认取值**：不涉及。 | | values | 否 | Array of strings | **参数解释**：一个字符串值数组。 **约束限制**：如果操作符是"In"或"NotIn"，则该值数组不能为空。如果操作符是"Exists"或"DoesNotExist"，则该值数组必须为空。如果操作符是"Gt"或"Lt"，则该值数组必须包含一个元素，该元素将被解释为整数。 | 表61LogExportConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | version | 否 | String | **参数解释**：日志版本号。 **约束限制**：不涉及。 **取值范围**：v0、v1 **默认取值**：v0。 | | rotation_enabled | 否 | Boolean | **参数解释**：是否开启日志分时段下载。 **约束限制**：不涉及。 **取值范围**： - true：开启日志分时段下载 - false：关闭日志分时段下载 **默认取值**：false。 | 表62Notification | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | topic_urn | 否 | String | **参数解释**：消息通知服务中所选主题的URN唯一资源标识。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | events | 否 | Array of strings | **参数解释**：触发消息通知的训练事件。 **约束限制**：枚举值： - JobStarted：作业开始 - JobCompleted：作业结束 - JobFailed：作业失败 - JobTerminated：作业终止 - JobRestarted：作业重启 - JobHanged：作业卡死 - JobPreempted：作业抢占 | 表63CustomMetrics | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | exec | 否 | [Exec] object | **参数解释**：命令行方式采集指标。 | | http_get | 否 | [HttpGet] object | **参数解释**：http方式采集指标。 | 表64Exec | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | command | 否 | Array of strings | **参数解释**： 命令行方式采集指标。 | 表65HttpGet | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | path | 否 | String | **参数解释**：http获取指标的url路径。 **约束限制**：与下面的端口port必须同时填或者不填。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | port | 否 | Integer | **参数解释**：http获取指标的端口。 **约束限制**：与上面的url路径必须同时填或者不填。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表66OutputModel | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs | 否 | [ObsModel] object | **参数解释**：自定义训练作业产物保存的OBS输出信息。 **约束限制**：不涉及。 | 表67ObsModel | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs_path | 是 | String | **参数解释**：自定义训练作业产物保存的OBS地址，如："obs://example/path"。 **取值范围**：不涉及。 | | local_path | 否 | String | **参数解释**：自定义训练作业产物保存的宿主机的路径，如："/example/path"。 **取值范围**：不涉及。 | 表68AssetModel | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**：模型名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | code | 否 | String | **参数解释**：模型编码。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | version | 是 | String | **参数解释**：模型发布版本。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | desc | 否 | String | **参数解释**：模型版本描述。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | series | 否 | String | **参数解释**：模型品牌。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | type | 是 | String | **参数解释**：模型类型。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | model_desc | 否 | String | **参数解释**：模型资产描述。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | parent_asset_id | 否 | String | **参数解释**：父资产ID（可选），选择已有模型时传递。。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | 表69ReserveTime | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | time_unit | 是 | String | **参数解释**：时间单位。 **约束限制**：不涉及。 **取值范围**： - HOURS：小时 **默认取值**：不涉及。 | | duration | 是 | Integer | **参数解释**：保留时长。 **约束限制**：不涉及。 **取值范围**：最小值为1。 **默认取值**：不涉及。 | 表70JobEndpointsReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ssh | 否 | [SSHReq] object | **参数解释**：SSH连接信息。 **约束限制**：不涉及。 | 表71SSHReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key_pair_names | 否 | Array of strings | **参数解释**：SSH密钥对名称，可以在云服务器控制台（ECS）"密钥对"页面创建和查看。 **约束限制**：不涉及。 | 表72MasJobConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ft_job_uuid | 否 | String | **参数解释**：精调作业UUID，可通过创建精调作业接口获取。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | ft_train_type | 否 | String | **参数解释**：精调训练作业的训练类型，支持的训练类型有预训练、全量微调、LoRA微调等。 **约束限制**：不涉及。 **取值范围**：SFT（全量微调）、PRETRAIN（预训练）、LORA（lora微调）。 **默认取值**：不涉及。 | | model_type | 否 | String | **参数解释**：训练任务选择的资产模型的类型，支持的模型类型有文本生成、图像理解。 **约束限制**：不涉及。 **取值范围**：TextGeneration（文本生成）、ImageUnderstanding（图像理解）。 **默认取值**：不涉及。 | | train_output_path | 否 | String | **参数解释**：精调训练作业产生的断点或者最终产物的存储路径，此路径是obs路径，在创建训练任务时由用户配置，如"obs://yyy/test/"。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | train_process | 否 | Double | **参数解释**：精调训练作业的进度。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | checkpoint_id | 否 | String | **参数解释**：断点ID，当训练作业是断点续训（基于已有检查点继续训练）时，此字段记录所基于的检查点的唯一标识符（UUID）。 **约束限制**：不涉及。 **取值范围**：UUID。 **默认取值**：不涉及。 | | task_env | 否 | [TaskEnv] object | **参数解释**：精调作业训练参数。 | | checkpoint_config | 否 | [CheckpointConf] object | **参数解释**：断点配置信息。 | 表73TaskEnv | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | envs | 否 | Array of [EnvVar] objects | **参数解释**：精调训练环境变量信息。 **约束限制**：不涉及。 | 表74EnvVar | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | label | 否 | String | **参数解释**：标签。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | des | 否 | String | **参数解释**：描述信息。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | env_name | 否 | String | **参数解释**：环境变量名称。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | env_type | 否 | String | **参数解释**：环境变量类型。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | value | 否 | String | **参数解释**：环境变量值。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | modifiable | 否 | Boolean | **参数解释**：是否可修改。 **约束限制**：不涉及。 **取值范围**： - true：可修改 - false：不可修改 **默认取值**：不涉及。 | | displayable | 否 | Boolean | **参数解释**：是否展示。 **约束限制**：不涉及。 **取值范围**： - true：展示 - false：不展示 **默认取值**：不涉及。 | | used_steps | 否 | Array of strings | **参数解释**：环境变量使用阶段。 **约束限制**：不涉及。 | 表75CheckpointConf | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | checkpoint_id | 否 | String | **参数解释**：断点ID。 **取值范围**：UUID。 | | save_checkpoints_max | 否 | Integer | **参数解释**：保存续训任务的步数。 **取值范围**： - 0：关闭不保存。 - 1：自动无限制。 | | skipped_steps | 否 | Integer | **参数解释**：断点续训时是否跳过步数，不跳过步数时主要解决由于硬件、网络相关的故障导致训练的中断；跳过步数时会跳过该checkpoint之后的部分数据（用户可配置），用于解决由于数据质量差导致的loss不收敛问题。 **取值范围**： - 0：不跳过。 - 1：跳过。 | | restore_training | 否 | Integer | **参数解释**：是否续训任务。 **取值范围**： - 0：非续训。 - 1：续训。 | #### 响应参数 **状态码：201** 表76响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | kind | String | **参数解释**：训练作业类型。 **取值范围**： - job：普通作业 - federated_pool_job：资源池联邦作业 - edge_job：边缘作业 - hetero_job：异构作业 - mrs_job：MRS作业 - autosearch_job：自动化搜索作业 - diag_job：诊断作业 - visualization_job：可视化作业 | | metadata | [JobMetadataResponse] object | **参数解释**：训练作业元信息。 | | status | [Status] object | **参数解释**：训练作业状态信息。 | | algorithm | [JobAlgorithmResponse] object | **参数解释**：训练作业算法。 | | tasks | Array of [TaskResponse] objects | **参数解释**：异构训练作业的任务列表。 | | spec | [SpecResponse] object | **参数解释**：训练作业规格参数。 | | endpoints | [JobEndpointsResp] object | **参数解释**：远程接入训练作业时需要的相关配置。 | | ftjob_config | [MasJobConfig] object | **参数解释**：精调训练作业参数。 | 表77JobMetadataResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：训练作业ID，创建成功后由ModelArts生成返回，无需填写。 **取值范围**：不涉及。 | | name | String | **参数解释**：训练作业名称。 **取值范围**：限制为1-64位只含数字、字母、下划线和中划线的名称。 | | workspace_id | String | **参数解释**：指定作业所处的工作空间。 **取值范围**：不涉及。 | | description | String | **参数解释**：对训练作业的描述。 **取值范围**：不涉及。 | | create_time | Long | **参数解释**：训练作业创建时间戳，单位为毫秒，创建成功后由ModelArts生成返回，无需填写。 **取值范围**：不涉及。 | | user_name | String | **参数解释**：训练作业创建用户的用户名，创建成功后由ModelArts生成返回，无需填写。 **取值范围**：不涉及。 | | annotations | Map\ | **参数解释**：训练作业高级功能配置，key 为功能开关/配置名，value 一律为字符串（即使是数字或布尔语义，也用字符串表示，如 "true"、"3"）。 | | training_experiment_reference | [TrainingExperimentResp] object | **参数解释**：训练实验参数。 | 表78TrainingExperimentResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：实验名称。 **取值范围**：最大长度128，不支持特殊字符。 | | id | String | **参数解释**：实验ID。 **取值范围**：不涉及。 | | serial_number | String | **参数解释**：当前训练作业在所属的训练实验中的序号，默认为0。 | 表79Status | 参数 | 参数类型 | 描述 | |:---|:---|:---| | phase | String | **参数解释**：训练作业一级状态。 **取值范围**： - Creating：创建中 - Pending：等待中 - Running：运行中 - Failed：运行失败 - Completed：已完成 - Terminating：停止中 - Terminated：已停止 - Abnormal：异常 | | secondary_phase | String | **参数解释**：训练作业二级状态为内部详细状态，可能会增加、修改、删除，不建议依赖。 **取值范围**： - Creating：创建中 - Queuing：排队中 - Running：运行中 - Failed：运行失败 - Completed：已完成 - Terminating：停止中 - Terminated：已停止 - CreateFailed：创建失败 - TerminatedFailed：停止失败 - Unknown：未知状态 - Lost：异常 | | duration | Long | **参数解释**：训练作业运行时长，单位为毫秒。 **取值范围**：不涉及。 | | node_count_metrics | Array\\> | **参数解释**：训练作业运行时节点数变化指标，每个内层数组表示一个 \[时间点, 运行节点数\] 二元组，记录某一时刻作业有多少个节点正在运行。 | | tasks | Array of strings | **参数解释**：训练作业子任务名称。 | | start_time | Long | **参数解释**：训练作业开始时间，格式为unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | | task_statuses | Array of [TaskStatuses] objects | **参数解释**：训练首个失败子任务状态信息。 | | running_records | Array of [RunningRecord] objects | **参数解释**：训练作业运行及故障恢复记录。 | | retention_time | Integer | **参数解释**：作业已经保留时长。 **取值范围**：不涉及。 | | task_ips | Array of [TaskIP] objects | **参数解释**：训练作业各 Task 的 IP 信息。 **取值范围**：不涉及。 | 表80TaskStatuses | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task | String | **参数解释**：训练作业子任务名称。 **取值范围**：不涉及。 | | exit_code | Integer | **参数解释**：训练作业子任务退出码。 **取值范围**：不涉及。 | | message | String | **参数解释**：训练作业子任务错误消息。 **取值范围**：不涉及。 | 表81RunningRecord | 参数 | 参数类型 | 描述 | |:---|:---|:---| | start_at | Long | **参数解释**：本次运行开始时间的unix时间戳，单位为秒(s)。 **取值范围**：不涉及。 | | end_at | Long | **参数解释**：本次运行结束时间的unix时间戳，单位为秒(s)。 **取值范围**：不涉及。 | | xpu_start_at | Long | **参数解释**：本次运行加速卡启动时间的unix时间戳，单位为秒(s)。 **取值范围**：不涉及。 | | start_type | String | **参数解释**：本次运行的启动方式。 **取值范围**： - init_or_rescheduled：代表本次启动为被调度后的首次运行，包括初次启动及调度恢复后的运行。 - restarted：代表本次启动非被调度后的首次运行，为进程重启后的运行。 | | end_reason | String | **参数解释**：本次运行结束原因。 **取值范围**：不涉及。 | | end_related_task | String | **参数解释**：引发本次运行结束的task worker ID(如worker-0)。 **取值范围**：不涉及。 | | end_recover | String | **参数解释**：本次运行异常结束时最终采取的故障容忍策略。 **取值范围**： - npu_proc_restart: NPU原地热恢复 - proc_restart: 进程原地重启 - npu_step_retry: Step重计算 - pod_reschedule: Pod级重调度 - job_reschedule: Job级重调度 - job_reschedule_with_taint: 隔离式Job重调度 | | end_recover_before_downgrade | String | **参数解释**：策略之间存在降级关系，即策略执行失败后会降级到指定的其他策略，end_recover_before_downgrade是end_recover降级前所采取的容忍策略。 **取值范围**：取值范围同end_recover。 | | recover_records | Array of [RecoverRecord] objects | **参数解释**：本次运行异常结束时采取的所有故障容忍策略详情。 | 表82RecoverRecord | 参数 | 参数类型 | 描述 | |:---|:---|:---| | recover_start_at | Long | **参数解释**：本次故障容忍策略开始执行时间的unix时间戳，单位为秒(s)，同时也是故障发生时间。 **取值范围**：不涉及。 | | recover_end_at | Long | **参数解释**：本次故障容忍策略结束时间的unix时间戳，单位为秒(s)。 **取值范围**：不涉及。 | | recover | String | **参数解释**：本次故障容忍策略。 **取值范围**：枚举值如下： - npu_step_retry: Step重计算 - npu_proc_restart: NPU原地热恢复 - proc_restart: 进程原地重启 - pod_reschedule: Pod级重调度 - job_reschedule: Job级重调度 - job_reschedule_with_taint: 隔离式Job重调度 | | fault_scenario | String | **参数解释**：本次故障场景。 **取值范围**：枚举值如下： - chip_fault: 芯片故障 - node_fault: 节点故障 - job_failed: 作业失败退出 - job_hanged: 作业卡死 - job_subhealth: 作业亚健康 - error_in_log: 日志异常 | | reason | String | **参数解释**：本次故障原因。 **取值范围**：不涉及。 | | related_task | String | **参数解释**：引发本次运行结束的task worker ID(如worker-0)。 **取值范围**：不涉及。 | | recover_result | String | **参数解释**：本次故障执行结果。 **取值范围**：枚举值如下： - recovering: 执行中 - success: 成功 - failed: 失败 - downgrade: 策略降级 - terminated: 策略被终止 - quotaExceeded: 策略执行次数超限制 | 表83TaskIP | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task | String | Task 名称，如 worker-0。 | | ip | String | Task/Pod IP 地址。 | | host_ip | String | 宿主机 IP。 | | schedule_count | Integer | 当前 Task 的第几次调度，默认 1。 重调度、抢占等场景下递增。 | 表84JobAlgorithmResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：训练作业算法ID。 | | name | String | **参数解释**：算法名称。 **取值范围**：不涉及。 | | subscription_id | String | **参数解释**：订阅算法的订阅ID。应与item_version_id一同出现。 **取值范围**：不涉及。 | | item_version_id | String | **参数解释**：订阅算法的版本。应与subscription_id一同出现。 **取值范围**：不涉及。 | | code_dir | String | **参数解释**：训练作业的代码目录。如："/usr/app/"。应与boot_file一同出现，如果boot_file已经填入id或subscription_id+item_version_id，则无需填写此参数。 **取值范围**：不涉及。 | | boot_file | String | **参数解释**：训练作业的代码启动文件，需要在代码目录下。如："/usr/app/boot.py"。应与code_dir一同出现，如果code_dir已经填入id或subscription_id+item_version_id，则无需填写此参数。 **取值范围**：不涉及。 | | autosearch_config_path | String | **参数解释**：自动化搜索作业的yaml配置路径，需要提供一个OBS路径。如："obs://bucket/file.yaml"。 **取值范围**：不涉及。 | | autosearch_framework_path | String | **参数解释**：自动化搜索作业的框架代码目录，需要提供一个OBS路径。如："obs://bucket/files/"。 **取值范围**：不涉及。 | | command | String | **参数解释**：自定义镜像训练作业的自定义镜像的容器的启动命令。例如python train.py。 **取值范围**：不涉及。 | | parameters | Array of [ParameterResp] objects | **参数解释**：训练作业的运行参数。 | | policies | [policies] object | **参数解释**：作业支持的策略。 | | inputs | Array of [InputResp] objects | **参数解释**：训练作业的数据输入。 | | outputs | Array of [OutputResp] objects | **参数解释**：训练作业的结果输出。 | | engine | [JobEngineResp] object | **参数解释**：训练作业的引擎。使用算法管理的算法id或订阅算法subscription_id+item_version_id创建作业时，无需填写。 | | local_code_dir | String | **参数解释**：算法的代码目录下载到训练容器内的本地路径。规则如下： - 必须为/home下的目录； - v1兼容模式下，当前字段不生效； - 当code_dir以file://为前缀时，当前字段不生效。 **取值范围**：不涉及。 | | working_dir | String | **参数解释**：运行算法时所在的工作目录。规则： v1兼容模式下，当前字段不生效。 **取值范围**：不涉及。 | | environments | Array of Map\ objects | **参数解释**：训练作业的环境变量。格式："key":"value"，无需填写。 | | summary | [SummaryResp] object | **参数解释**：可视化日志summary。 | 表85ParameterResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：参数名称。 **取值范围**：不涉及。 | | value | String | **参数解释**：参数值。 **取值范围**：不涉及。 | | description | String | **参数解释**：参数描述信息。 **取值范围**：不涉及。 | | constraint | [constraint] object | **参数解释**：参数属性。 | | i18n_description | [i18n_description] object | **参数解释**：国际化描述。 | 表86constraint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**：参数种类。 **取值范围**：枚举值如下： - Integer：整数 - Float：浮点数 - String：字符串 - Boolean：布尔值 | | editable | Boolean | **参数解释**：是否可编辑。 **取值范围**： - true：可编辑 - false：不可编辑 | | required | Boolean | **参数解释**：是否必须。 **取值范围**： - true：必须 - false：非必须 | | sensitive | Boolean | **参数解释**：是否敏感。该功能暂未实现。 **取值范围**： - true：敏感 - false：不敏感 | | valid_type | String | **参数解释**：有效种类。 **取值范围**：枚举值如下： - Choice：枚举值 - Range：范围值 - None：无 | | valid_range | Array of strings | **参数解释**：有效范围。 | 表87i18n_description | 参数 | 参数类型 | 描述 | |:---|:---|:---| | language | String | **参数解释**：国际语种。可选值如下： - zh-cn（中文） - en-us（英文） **取值范围**：不涉及。 | | description | String | **参数解释**：国际化语种的描述信息。 **取值范围**：不涉及。 | 表88policies | 参数 | 参数类型 | 描述 | |:---|:---|:---| | auto_search | [auto_search] object | **参数解释**：超参搜索配置。 | 表89auto_search | 参数 | 参数类型 | 描述 | |:---|:---|:---| | skip_search_params | String | **参数解释**：需要排除的超参组合。 **取值范围**：不涉及。 | | reward_attrs | Array of [reward_attrs] objects | **参数解释**：搜索指标列表。 | | search_params | Array of [search_params] objects | **参数解释**：搜索参数。 | | algo_configs | Array of [algo_configs] objects | **参数解释**：搜索算法配置。 | 表90reward_attrs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：指标名称。 **取值范围**：不涉及。 | | mode | String | **参数解释**：搜索方向。 **取值范围**： - max：表示指标值越大越好 - min：表示指标值越小越好 | | regex | String | **参数解释**：指标正则表达式。 **取值范围**：不涉及。 | 表91search_params | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：超参名称。 **取值范围**：不涉及。 | | param_type | String | **参数解释**：参数类型。 **取值范围**： - continuous：表示这个超参是连续类型的。连续类型的超参在算法使用于训练作业时，控制台显示为输入框。 - discrete：表示这个超参是离散类型的。离散类型的超参在算法使用于训练作业时，控制台显示为下拉选择框架。 | | lower_bound | String | **参数解释**：超参下界。 **取值范围**：不涉及。 | | upper_bound | String | **参数解释**：超参上界。 **取值范围**：不涉及。 | | discrete_points_num | String | **参数解释**：连续型超参离散化取值个数。 **取值范围**：不涉及。 | | discrete_values | Array of strings | **参数解释**：离散型超参的取值列表。 | 表92algo_configs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：搜索算法名称。 **取值范围**：不涉及。 | | params | Array of [AutoSearchAlgoConfigParameterResp] objects | **参数解释**：搜索算法参数。 | 表93AutoSearchAlgoConfigParameterResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：参数键。 **取值范围**：不涉及。 | | value | String | **参数解释**：参数值。 **取值范围**：不涉及。 | | type | String | **参数解释**：参数种类。 **取值范围**：枚举值如下： - obs：数据存储位置（OBS） - modelarts_dataset：ModelArts数据集 | 表94InputResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：数据输入通道名称。 **取值范围**：不涉及。 | | description | String | **参数解释**：数据输入通道描述信息。 **取值范围**：不涉及。 | | local_dir | String | **参数解释**：数据输入通道映射的容器本地路径。例如，"/home/ma-user/modelarts/inputs/data_url_0"。 **取值范围**：不涉及。 | | access_method | String | **参数解释**：数据输入通道路径（local_dir）的下发方式。 **取值范围**： - parameter：超参形式 - env：环境变量形式 | | remote | [InputDataInfoResp] object | **参数解释**：数据实际输入信息。 | | remote_constraint | Array of [remote_constraint] objects | **参数解释**：数据输入约束。 | 表95InputDataInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dataset | [dataset] object | **参数解释**：数据输入信息为数据集，兼容新版数据集和旧版数据集功能，其中旧版数据集功能即将下线，推荐使用新版数据集。 | | obs | [obs] object | **参数解释**：数据输入输出信息为OBS方式。 | 表96dataset | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：训练作业的数据集ID。 **取值范围**：不涉及。 | | version_id | String | **参数解释**：训练作业的数据集版本ID。 **取值范围**：不涉及。 | | obs_url | String | **参数解释**：训练作业需要的数据集OBS路径URL，ModelArts会通过数据集ID和数据集版本ID自动解析生成。如："/usr/data/"。 **取值范围**：不涉及。 | | service_type | String | **参数解释**：数据集服务类型。 | | name | String | **参数解释**：训练作业的数据集名称。 **取值范围**：不涉及。 | 表97obs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs_url | String | **参数解释**：训练作业需要的数据集OBS路径URL。如："/usr/data/"。 **取值范围**：不涉及。 | 表98remote_constraint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data_type | String | **参数解释**：数据输入类型，包括数据存储位置、数据集两种方式，其中数据集功能即将下线。 | | attributes | String | **参数解释**：相关属性。 **取值范围**： 数据输入为数据集时： - data_format：数据格式 - data_segmentation：数据切分方式 - dataset_type：标注类型 | 表99OutputResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：数据输出通道名称。 **取值范围**：不涉及。 | | description | String | **参数解释**：数据输出通道描述信息。 **取值范围**：不涉及。 | | local_dir | String | **参数解释**：数据输出通道映射的容器本地路径。 **取值范围**：不涉及。 | | access_method | String | **参数解释**：数据输入通道路径（local_dir）的下发方式。 **取值范围**： - parameter：超参形式 - env：环境变量形式 | | remote | [RemoteResp] object | **参数解释**：数据实际输出信息。 | 表100JobEngineResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | engine_id | String | **参数解释**：训练作业选择的引擎规格ID。 **取值范围**：不涉及。 | | engine_name | String | **参数解释**：训练作业选择的引擎规格名称。 **取值范围**：不涉及。 | | engine_version | String | **参数解释**：训练作业选择的引擎规格版本。 **取值范围**：不涉及。 | | image_url | String | **参数解释**：训练作业选择的自定义镜像地址，地址从swr服务获取。 **取值范围**：不涉及。 | | install_sys_packages | Boolean | **参数解释**：是否需要安装训练平台指定的 moxing 版本。 **取值范围**： - true：需要 - false：不需要 | | image_repo_id | String | **参数解释**：SWR企业仓实例ID，使用企业仓自定义镜像时需传入。 **取值范围**：合法的SWR企业仓实例ID。 | 表101SummaryResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | log_type | String | **参数解释**：训练作业可视化日志类型，配置后训练作业可作为可视化作业数据源。 **取值范围**： - tensorboard：输出TensorBoard可视化工具类型的日志 - mindstudio-insight：输出mindstudio-insight可视化工具类型的日志 | | log_dir | [LogDirResp] object | **参数解释**：训练作业可视化日志输出。 | | data_sources | Array of [DataSourceResp] objects | **参数解释**：可视化作业或训练作业调试模式的可视化日志输入。 | 表102LogDirResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pfs | [PFSSummaryResp] object | **参数解释**：obs并行文件系统输出。 | 表103PFSSummaryResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pfs_path | String | **参数解释**：obs并行文件系统路径url。 **取值范围**：不涉及。 | 表104DataSourceResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job | [JobSummaryResp] object | **参数解释**：作业数据源。 | 表105JobSummaryResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**：训练作业id。 **取值范围**：不涉及。 | 表106TaskResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | role | String | **参数解释**：任务角色，该功能暂未支持。 **取值范围**：不涉及。 | | algorithm | [TaskResponseAlgorithm] object | **参数解释**：算法管理算法配置。 | | task_resource | [FlavorResponse] object | **参数解释**：训练作业、算法的规格信息。 | | log_export_path | [log_export_path] object | **参数解释**：训练作业日志保存信息。 | 表107TaskResponseAlgorithm | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code_dir | String | **参数解释**：算法启动文件所在目录绝对路径。 **取值范围**：不涉及。 | | boot_file | String | **参数解释**：算法启动文件绝对路径。 **取值范围**：不涉及。 | | inputs | [AlgorithmInput] object | **参数解释**：算法输入通道信息。 | | outputs | [AlgorithmOutput] object | **参数解释**：算法输出通道信息。 | | engine | [AlgorithmEngine] object | **参数解释**：异构作业所依赖的引擎。 | | local_code_dir | String | **参数解释**：算法的代码目录下载到训练容器内的本地路径。规则如下： - 必须为/home下的目录； - v1兼容模式下，当前字段不生效； - 当code_dir以file://为前缀时，当前字段不生效。 **取值范围**：不涉及。 | | working_dir | String | **参数解释**：运行算法时所在的工作目录。规则：v1兼容模式下，当前字段不生效。 **取值范围**：不涉及。 | | environments | Map\ | **参数解释**：训练作业相关的环境变量。 **取值范围**：不涉及。 | 表108AlgorithmInput | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：数据输入通道名称。 **取值范围**：不涉及。 | | local_dir | String | **参数解释**：数据输入输出通道映射的容器本地路径。 **取值范围**：不涉及。 | | remote | [AlgorithmRemote] object | **参数解释**：数据实际输入信息，异构作业只支持OBS。 | 表109AlgorithmRemote | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs | [RemoteObsResp] object | **参数解释**：数据输入输出信息为OBS方式。 | 表110AlgorithmOutput | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：数据输出通道名称。 **取值范围**：不涉及。 | | local_dir | String | **参数解释**：数据输出通道映射的容器本地路径。 **取值范围**：不涉及。 | | remote | [RemoteResp] object | **参数解释**：数据实际输出信息。 | | mode | String | **参数解释**：数据传输模式，默认为"upload_periodically"。 **取值范围**：不涉及。 | | period | String | **参数解释**：数据传输周期，默认为30s。 **取值范围**：不涉及。 | 表111RemoteResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs | [RemoteObsResp] object | **参数解释**：数据实际输出到OBS。 | 表112RemoteObsResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs_url | String | **参数解释**：数据实际输出到OBS的路径，如："obs://example/path"。 **取值范围**：不涉及。 | 表113AlgorithmEngine | 参数 | 参数类型 | 描述 | |:---|:---|:---| | engine_id | String | **参数解释**：引擎规格的ID。如"caffe-1.0.0-python2.7"。 **取值范围**：不涉及。 | | engine_name | String | **参数解释**：引擎规格的名称。如"Caffe"。 **取值范围**：不涉及。 | | engine_version | String | **参数解释**：引擎规格的版本。对一个引擎名称，有多个版本的引擎，如使用python2.7的"Caffe-1.0.0-python2.7"等。 **取值范围**：不涉及。 | | v1_compatible | Boolean | **参数解释**：是否为v1兼容模式。 **取值范围**： - true：兼容v1 - false：不兼容v1 | | run_user | String | **参数解释**：引擎默认启动用户uid。 **取值范围**：不涉及。 | | image_url | String | **参数解释**：算法选择的自定义镜像地址，如"train-image/pytorch_2_1_xxx:1.0.1"，地址从SWR服务获取。 **取值范围**：不涉及。 | 表114FlavorResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pool_id | String | **参数解释**：训练作业选择的资源池ID。 **取值范围**：不涉及。 | | flavor_id | String | **参数解释**：资源规格的ID。 **取值范围**：不涉及。 | | flavor_name | String | **参数解释**：资源规格的名称。 **取值范围**：不涉及。 | | max_num | Integer | **参数解释**：资源规格的最大节点数。 **取值范围**：不涉及。 | | flavor_type | String | **参数解释**：资源规格的类型。 **取值范围**： - CPU：CPU资源规格 - GPU：GPU资源规格 - Ascend：NPU资源规格 | | billing | [BillingInfo] object | **参数解释**：资源规格计费信息。 | | flavor_info | [FlavorInfoResponse] object | **参数解释**：资源规格详细信息。 | | attributes | Map\ | **参数解释**：其他规格属性。 **取值范围**：不涉及。 | 表115FlavorInfoResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | max_num | Integer | **参数解释**：可以选择的最大节点数量（max_num，为1代表不支持分布式）。 **取值范围**：不涉及。 | | cpu | [Cpu] object | **参数解释**：cpu规格信息。 | | gpu | [Gpu] object | **参数解释**：gpu规格信息。 | | npu | [Npu] object | **参数解释**：Ascend规格信息。 | | memory | [Memory] object | **参数解释**：内存信息。 | | disk | [DiskResponse] object | **参数解释**：磁盘信息。 | 表116DiskResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | **参数解释**：磁盘大小。 **取值范围**：不涉及。 | | unit | String | **参数解释**：磁盘大小单位。 **取值范围**：不涉及。 | 表117log_export_path | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs_url | String | **参数解释**：训练作业日志保存OBS路径。 | 表118SpecResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource | [Resource] object | **参数解释**：训练作业资源规格信息。flavor_id和pool_id+\[flavor_id\]方式二选一。 | | volumes | Array of [JobVolumeResp] objects | **参数解释**：训练作业挂载卷信息。 | | log_export_path | [LogExportPathResp] object | **参数解释**：训练作业日志输出信息。 | | schedule_policy | [SchedulePolicyResp] object | **参数解释**：训练作业调度策略。 | | custom_metrics | Array of [CustomMetrics] objects | **参数解释**：指标采集配置。 | | output_model | [OutputModelResp] object | **参数解释**：自定义训练作业产物输出信息。 | | asset_model | [AssetModelResp] object | **参数解释**：自定义训练作业产物发布成模型的信息。 | 表119Resource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy | String | **参数解释**：训练作业资源规格模式。 **取值范围**： - regular：标准模式 | | flavor_id | String | **参数解释**：训练作业资源规格id，CPU规格专属资源池不支持指定flavor_id。 **取值范围**：GPU/Ascend规格专属资源池可选取值如下： - modelarts.pool.visual.xlarge（1卡） - modelarts.pool.visual.2xlarge（2卡） - modelarts.pool.visual.4xlarge（4卡） - modelarts.pool.visual.8xlarge（8卡） | | flavor_name | String | **参数解释**：使用flavor_id时，由ModelArts返回的只读规格名称。 **取值范围**：不涉及。 | | node_count | Integer | **参数解释**：训练作业选择的资源副本数。 **取值范围**：大于等于1。 | | pool_id | String | **参数解释**：训练作业选择的资源池ID。 **取值范围**：不涉及。 | | pool_group_id | String | **参数解释**：训练作业选择的资源池联邦ID。 **取值范围**：不涉及。 | | flavor_detail | [FlavorDetail] object | **参数解释**：训练作业、算法的规格信息（该字段只有公共资源池存在）。 | | main_container_allocated_resources | [MainContainerAllocatedResources] object | **参数解释**：训练作业训练容器实际到手的资源规格。 | | main_container_customized_flavor | [MainContainerCustomizedFlavor] object | **参数解释**：训练作业自定义规格。 | 表120FlavorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | flavor_type | String | **参数解释**：资源规格的类型。 **取值范围**： - CPU：CPU资源规格 - GPU：GPU资源规格 - Ascend：NPU资源规格 | | billing | [BillingInfo] object | **参数解释**：资源规格计费信息。 | | flavor_info | [FlavorInfo] object | **参数解释**：资源规格详细信息。 | 表121BillingInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**：计费码。 **取值范围**：不涉及。 | | unit_num | Integer | **参数解释**：计费单元。 **取值范围**：不涉及。 | 表122FlavorInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | max_num | Integer | **参数解释**：可以选择的最大节点数量（max_num，为1代表不支持分布式）。 **取值范围**：不涉及。 | | cpu | [Cpu] object | **参数解释**：cpu规格信息。 | | gpu | [Gpu] object | **参数解释**：gpu规格信息。 | | npu | [Npu] object | **参数解释**：Ascend规格信息。 | | memory | [Memory] object | **参数解释**：内存信息。 | | disk | [Disk] object | **参数解释**：磁盘信息。 | 表123Cpu | 参数 | 参数类型 | 描述 | |:---|:---|:---| | arch | String | **参数解释**：cpu架构。 **取值范围**：不涉及。 | | core_num | Integer | **参数解释**：核数。 **取值范围**：不涉及。 | 表124Gpu | 参数 | 参数类型 | 描述 | |:---|:---|:---| | unit_num | Integer | **参数解释**：gpu卡数。 **取值范围**：不涉及。 | | product_name | String | **参数解释**：产品名。 **取值范围**：不涉及。 | | memory | String | **参数解释**：内存，单位GB。 **取值范围**：不涉及。 | 表125Npu | 参数 | 参数类型 | 描述 | |:---|:---|:---| | unit_num | String | **参数解释**：npu卡数。 **取值范围**：不涉及。 | | product_name | String | **参数解释**：产品名。 **取值范围**：不涉及。 | | memory | String | **参数解释**：内存。 **取值范围**：不涉及。 | 表126Memory | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | **参数解释**：内存大小。 **取值范围**：不涉及。 | | unit | String | **参数解释**：内存单元数。 **取值范围**：不涉及。 | 表127Disk | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | String | **参数解释**：磁盘大小。 **取值范围**：不涉及。 | | unit | String | **参数解释**：磁盘大小单位，一般为GB。 **取值范围**：不涉及。 | 表128MainContainerAllocatedResources | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu_arch | String | **参数解释**： cpu架构。 **取值范围**： 不涉及。 | | cpu_core_num | Float | **参数解释**： 核数。 **取值范围**： 不涉及。 | | mem_size | Float | **参数解释**： 内存信息。 **取值范围**： 不涉及。 | | accelerator_num | Float | **参数解释**： 加速卡卡数。 **取值范围**： 不涉及。 | | accelerator_type | String | **参数解释**： 加速卡类型。如：ascend-Snt9b，ascend-snt9c等 **取值范围**： 不涉及。 | 表129MainContainerCustomizedFlavor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu_core_num | Float | **参数解释**：cpu核数。 **取值范围**：大于零。 | | mem_size | Float | **参数解释**：内存大小，单位GB。 **取值范围**：大于零。 | | accelerator_num | Float | **参数解释**：加速卡卡数。 **取值范围**：大于等于零。 | 表130JobVolumeResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | nfs | [NfsResp] object | **参数解释**：nfs方式的挂载卷。 | 表131NfsResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | nfs_server_path | String | **参数解释**：nfs服务端路径，如："10.10.10.10:/example/path"。 **取值范围**：不涉及。 | | local_path | String | **参数解释**：挂载到训练容器中的路径，如："/example/path"。 **取值范围**：不涉及。 | | read_only | Boolean | **参数解释**：nfs挂载卷在容器中是否只读。 **取值范围**： - true：只读 - false：非只读 | 表132LogExportPathResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs_url | String | **参数解释**：训练作业日志保存的OBS地址，如："obs://example/path"。 **取值范围**：不涉及。 | | host_path | String | **参数解释**：训练作业日志保存的宿主机的路径，如："/example/path"。 **取值范围**：不涉及。 | 表133SchedulePolicyResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | required_affinity | [RequiredAffinityResp] object | **参数解释**：训练作业亲和要求。 | | priority | Integer | **参数解释**：训练作业优先级。 **取值范围**：0-3 | | preemptible | Boolean | **参数解释**：是否可以被抢占。 **取值范围**： - true：可以被抢占 - false：不可以被抢占 | 表134RequiredAffinityResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | affinity_type | String | **参数解释**：亲和调度策略。 **取值范围**： - cabinet：强整柜调度 - hyperinstance：超节点亲和调度 | | job_level | String | **参数解释**：作业整体的网络拓扑约束，affinity_type为networkTopology时有效，系统会将作业的所有task调度至不高于job_level层的节点组中。 用户向超节点资源池投递训练作业，如果未设置作业整体的网络拓扑约束，系统会默认赋值为cluster。 **取值范围**： - cluster：资源池级 - hyperinstanceGroup: 超节点级 | | affinity_group_size | Integer | **参数解释**：亲和组大小。 **取值范围**：不涉及。 | | affinity_group_level | String | **参数解释**：亲和组的网络拓扑约束，affinity_type为networkTopology时有效，系统会将affinity_group_size个task组成的亲和组调度至不高于affinity_group_level层的节点组中。 用户向超节点资源池投递训练作业，如果未设置亲和组的网络拓扑约束，系统会默认赋值为hyperinstanceGroup。 **取值范围**： - hyperinstance：超节点级 - slice: 柜级 | 表135CustomMetrics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | exec | [Exec] object | **参数解释**：命令行方式采集指标。 | | http_get | [HttpGet] object | **参数解释**：http方式采集指标。 | 表136Exec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | command | Array of strings | **参数解释**： 命令行方式采集指标。 | 表137HttpGet | 参数 | 参数类型 | 描述 | |:---|:---|:---| | path | String | **参数解释**：http获取指标的url路径。 **取值范围**：不涉及。 | | port | Integer | **参数解释**：http获取指标的端口。 **取值范围**：不涉及。 | 表138OutputModelResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs | [ObsModelResp] object | **参数解释**：自定义训练作业产物保存的OBS输出信息。 | 表139ObsModelResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs_path | String | **参数解释**：自定义训练作业产物保存的OBS地址，如："obs://example/path"。 **取值范围**：不涉及。 | | local_path | String | **参数解释**：自定义训练作业产物保存的宿主机的路径，如："/example/path"。 **取值范围**：不涉及。 | 表140AssetModelResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：模型id。 **取值范围**：不涉及。 | | name | String | **参数解释**：模型名称。 **取值范围**：不涉及。 | | code | String | **参数解释**：模型编码。 **取值范围**：不涉及。 | | version | String | **参数解释**：模型发布版本。 **取值范围**：不涉及。 | | location | String | **参数解释**：模型发布地址。 **取值范围**：不涉及。 | | desc | String | **参数解释**：模型描述。 **取值范围**：不涉及。 | | series | String | **参数解释**：模型品牌。 **取值范围**：不涉及。 | | type | String | **参数解释**：模型类型。 **取值范围**：不涉及。 | 表141JobEndpointsResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ssh | [SSHResp] object | **参数解释**：SSH连接信息。 | | jupyter_lab | [JupyterLab] object | **参数解释**：JupyterLab连接信息。 | | tensorboard | [Tensorboard] object | **参数解释**：Tensorboard连接信息。 | | mindstudio_insight | [MindStudioInsight] object | **参数解释**：MindStudio Insight连接信息。 | 表142SSHResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key_pair_names | Array of strings | **参数解释**：SSH密钥对名称，可以在云服务器控制台（ECS）"密钥对"页面创建和查看。 **取值范围**：不涉及。 | | task_urls | Array of [TaskUrls] objects | **参数解释**：SSH连接地址信息。 | 表143TaskUrls | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task | String | **参数解释**：训练作业的任务ID。 **取值范围**：不涉及。 | | url | String | **参数解释**：训练作业SSH连接地址。 **取值范围**：不涉及。 | 表144JupyterLab | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | **参数解释**：训练作业的JupyterLab地址。 **取值范围**：不涉及。 | | token | String | **参数解释**：训练作业的JupyterLab token。 **取值范围**：不涉及。 | 表145Tensorboard | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | **参数解释**：训练作业的Tensorboard地址。 **取值范围**：不涉及。 | | token | String | **参数解释**：训练作业的Tensorboard token。 **取值范围**：不涉及。 | 表146MindStudioInsight | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | **参数解释**：训练作业的MindStudio Insight地址。 **取值范围**：不涉及。 | | token | String | **参数解释**：训练作业的MindStudio Insight token。 **取值范围**：不涉及。 | 表147MasJobConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ft_job_uuid | String | **参数解释**：精调作业UUID，可通过创建精调作业接口获取。 **取值范围**：不涉及。 | | ft_train_type | String | **参数解释**：精调训练作业的训练类型，支持的训练类型有预训练、全量微调、LoRA微调等。 **取值范围**：SFT（全量微调）、PRETRAIN（预训练）、LORA（lora微调）。 | | model_type | String | **参数解释**：训练任务选择的资产模型的类型，支持的模型类型有文本生成、图像理解。 **取值范围**：TextGeneration（文本生成）、ImageUnderstanding（图像理解）。 | | train_output_path | String | **参数解释**：精调训练作业产生的断点或者最终产物的存储路径，此路径是obs路径，在创建训练任务时由用户配置，如"obs://yyy/test/"。 **取值范围**：不涉及。 | | train_process | Double | **参数解释**：精调训练作业的进度。 **取值范围**：不涉及。 | | checkpoint_id | String | **参数解释**：断点ID，当训练作业是断点续训（基于已有检查点继续训练）时，此字段记录所基于的检查点的唯一标识符（UUID）。 **取值范围**：UUID。 | | task_env | [TaskEnv] object | **参数解释**：精调作业训练参数。 | | checkpoint_config | [CheckpointConf] object | **参数解释**：断点配置信息。 | 表148TaskEnv | 参数 | 参数类型 | 描述 | |:---|:---|:---| | envs | Array of [EnvVar] objects | **参数解释**：精调训练环境变量信息。 | 表149EnvVar | 参数 | 参数类型 | 描述 | |:---|:---|:---| | label | String | **参数解释**：标签。 **取值范围**：不涉及。 | | des | String | **参数解释**：描述信息。 **取值范围**：不涉及。 | | env_name | String | **参数解释**：环境变量名称。 **取值范围**：不涉及。 | | env_type | String | **参数解释**：环境变量类型。 **取值范围**：不涉及。 | | value | String | **参数解释**：环境变量值。 **取值范围**：不涉及。 | | modifiable | Boolean | **参数解释**：是否可修改。 **取值范围**： - true：可修改 - false：不可修改 | | displayable | Boolean | **参数解释**：是否展示。 **取值范围**： - true：展示 - false：不展示 | | used_steps | Array of strings | **参数解释**：环境变量使用阶段。 | 表150CheckpointConf | 参数 | 参数类型 | 描述 | |:---|:---|:---| | checkpoint_id | String | **参数解释**：断点ID。 **取值范围**：UUID。 | | save_checkpoints_max | Integer | **参数解释**：保存续训任务的步数。 **取值范围**： - 0：关闭不保存。 - 1：自动无限制。 | | skipped_steps | Integer | **参数解释**：断点续训时是否跳过步数，不跳过步数时主要解决由于硬件、网络相关的故障导致训练的中断；跳过步数时会跳过该checkpoint之后的部分数据（用户可配置），用于解决由于数据质量差导致的loss不收敛问题。 **取值范围**： - 0：不跳过。 - 1：跳过。 | | restore_training | Integer | **参数解释**：是否续训任务。 **取值范围**： - 0：非续训。 - 1：续训。 | **状态码：400** 表151响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | 错误信息。 | | error_code | String | 错误码。 | | error_solution | String | 错误解决建议。 | #### 请求示例 - 创建免费规格的训练作业。设置作业名称为"TestModelArtsJob"，描述为"This is a ModelArts job"。算法依赖的是id为3f5d6706-7b67-408d-8ba0-ec08048c45ed的算法，该算法未定义inputs与outputs，规格选用的是gpu免费规格。 ``` POST https://{endpoint}/v2/{project_id}/training-jobs { "kind" : "job", "metadata" : { "name" : "TestModelArtsJob", "description" : "This is a ModelArts job", "workspace_id" : "0" }, "algorithm" : { "id" : "3f5d6706-7b67-408d-8ba0-ec08048c45ed", "name" : "ttt-obs-gpu", "code_dir" : "/cn-north-4-rse/test/moxingtest-code/", "boot_file" : "/cn-north-4-rse/test/moxingtest-code/test_obs_gpu.py", "parameters" : [ { "name" : "input_dir", "description" : "", "i18n_description" : null, "value" : "obs://cn-north-4-rse/test/moxingtest-dir/", "constraint" : { "type" : "String", "editable" : true, "required" : true, "sensitive" : false, "valid_type" : "None", "valid_range" : [ ] } }, { "name" : "input_file", "description" : "", "i18n_description" : null, "value" : "obs://cn-north-4-rse/test/moxingtest/", "constraint" : { "type" : "String", "editable" : true, "required" : true, "sensitive" : false, "valid_type" : "None", "valid_range" : [ ] } }, { "name" : "large_file_method", "description" : "", "i18n_description" : null, "value" : "1", "constraint" : { "type" : "Integer", "editable" : true, "required" : true, "sensitive" : false, "valid_type" : "None", "valid_range" : [ ] } } ], "engine" : { "engine_id" : "horovod-cp36-tf-1.16.2", "engine_name" : "Horovod", "engine_version" : "0.16.2-TF-1.13.1-python3.6" }, "policies" : { } }, "spec" : { "resource" : { "flavor_id" : "modelarts.p3.large.public.free", "node_count" : 1 }, "log_export_path" : { }, "custom_metrics" : [ { "http_get" : { "path" : "/raw_text", "port" : 10001 } } ] } } ``` - 使用自定义镜像创建训练作业。设置作业名称为"TestModelArtsJob2"，描述为"This is a ModelArts job2"的自定义镜像训练作业。使用专属资源池和nfs挂载。 ``` POST https://{endpoint}/v2/{project_id}/training-jobs { "kind" : "job", "metadata" : { "name" : "TestModelArtsJob2", "description" : "This is a ModelArts job2" }, "algorithm" : { "engine" : { "image_url" : "xxxxxxxx/fastseq:1.2" }, "command" : "cd /home/ma-user/ddp_demo && sh run_ddp.sh", "parameters" : [ ], "policies" : { "auto_search" : null }, "environments" : { "NCCL_DEBUG" : "INFO", "NCCL_IB_DISABLE" : "0" } }, "spec" : { "resource" : { "flavor_id" : "modelarts.pool.visual.xlarge", "node_count" : 1, "pool_id" : "poolfaf38d76" }, "log_export_path" : { "obs_url" : "/cn-north-4-training-test/limou/ddp-demo-log/" }, "volumes" : [ { "nfs" : { "nfs_server_path" : "192.0.2.1:/", "local_path" : "/home/ma-user/nfs/", "read_only" : false } } ] } } ``` #### 响应示例 **状态码：201** ok ``` { "kind" : "job", "metadata" : { "id" : "425b7087-83de-49ed-9e40-5bb642be956f", "name" : "TestModelArtsJob", "description" : "This is a ModelArts job", "create_time" : 1637045545982, "workspace_id" : "0", "user_name" : "" }, "status" : { "phase" : "Creating", "secondary_phase" : "Creating", "duration" : 0, "start_time" : 0, "node_count_metrics" : null, "tasks" : [ "worker-0", "server-0" ] }, "algorithm" : { "id" : "3f5d6706-7b67-408d-8ba0-ec08048c45ed", "name" : "ttt-obs-gpu", "code_dir" : "/cn-north-4-rse/test/moxingtest-code/", "boot_file" : "/cn-north-4-rse/test/moxingtest-code/test_obs_gpu.py", "parameters" : [ { "name" : "input_dir", "description" : "", "i18n_description" : null, "value" : "obs://cn-north-4-rse/test/moxingtest-dir/", "constraint" : { "type" : "String", "editable" : true, "required" : true, "sensitive" : false, "valid_type" : "None", "valid_range" : [ ] } }, { "name" : "input_file", "description" : "", "i18n_description" : null, "value" : "obs://cn-north-4-rse/test/moxingtest/", "constraint" : { "type" : "String", "editable" : true, "required" : true, "sensitive" : false, "valid_type" : "None", "valid_range" : [ ] } }, { "name" : "large_file_method", "description" : "", "i18n_description" : null, "value" : "1", "constraint" : { "type" : "Integer", "editable" : true, "required" : true, "sensitive" : false, "valid_type" : "None", "valid_range" : [ ] } } ], "engine" : { "engine_id" : "horovod-cp36-tf-1.16.2", "engine_name" : "Horovod", "engine_version" : "0.16.2-TF-1.13.1-python3.6" }, "policies" : { } }, "spec" : { "resource" : { "policy" : "regular", "flavor_id" : "modelarts.p3.large.public.free", "flavor_name" : "Computing GPU(Vnt1) instance", "node_count" : 1, "flavor_detail" : { "flavor_type" : "GPU", "billing" : { "code" : "modelarts.vm.gpu.free", "unit_num" : 1 }, "flavor_info" : { "cpu" : { "arch" : "x86", "core_num" : 8 }, "gpu" : { "unit_num" : 1, "product_name" : "GP-Vnt1", "memory" : "32GB" }, "memory" : { "size" : 64, "unit" : "GB" } } }, "main_container_allocated_resources" : { "cpu_arch" : "x86", "cpu_core_num" : 5, "mem_size" : 44, "accelerator_num" : 1, "accelerator_type" : "nvidia-v100-pcie32" } }, "log_export_path" : { }, "custom_metrics" : [ { "exec" : { "command" : [ "cat", "/a/b/c.prom" ] } }, { "http_get" : { "path" : "/raw_text", "port" : 10001 } } ] } } ``` **状态码：400** 通用的错误应答消息体格式；如下为id是3f5d6706-7b67-408d-8ba0-ec08048c45ee的算法未找到时的返回信息。 ``` { "error_msg" : "algorithm not found.", "error_code" : "ModelArts.2755", "error_solution" : "Check whether the training project information in the request is valid." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | ok | | 400 | 通用的错误应答消息体格式；如下为id是3f5d6706-7b67-408d-8ba0-ec08048c45ee的算法未找到时的返回信息。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。