更新时间:2025-11-17 GMT+08:00
分享

创建训练实验

功能介绍

创建训练实验接口用于在ModelArts平台上创建新的实验分类。

该接口适用于以下场景:当用户需要将训练作业放入实验中分类,有序地进行管理,可以通过此接口创建训练实验,常用于多任务的版本管理等场景。使用该接口的前提条件是用户已登录ModelArts平台并具有创建训练实验的权限。创建操作完成后,系统将返回训练实验的详细信息,包括实验ID、当前实验下的训练作业总个数等。若用户无权限操作,接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/training-experiments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

约束限制:1 - 64字符,字母、数字和中划线。

取值范围:不涉及。

默认取值:不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

metadata

TrainingExperimentRequestMetadata object

参数解释:训练实验创建参数。

约束限制:不涉及。

表3 TrainingExperimentRequestMetadata

参数

是否必选

参数类型

描述

name

String

参数解释:实验名称。

约束限制:最大长度64,不支持特殊字符。

取值范围:不涉及。

默认取值:不涉及。

description

String

参数解释:描述信息。

约束限制:最大长度256,不支持特殊字符。

取值范围:不涉及。

默认取值:不涉及。

workspace_id

String

参数解释:工作空间ID。

约束限制:不涉及。

取值范围:不涉及。

默认取值:默认为0。

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

metadata

TrainingExperimentResponseMetadata object

参数解释:训练实验数据。

statistic

TrainingExperimentStatistic object

参数解释:训练实验的统计数据。

表5 TrainingExperimentResponseMetadata

参数

参数类型

描述

name

String

参数解释:实验名称。

取值范围:不涉及。

description

String

参数解释:描述信息。

取值范围:不涉及。

workspace_id

String

参数解释:工作空间ID。

取值范围:不涉及。

create_time

Integer

参数解释:创建时间。

取值范围:不涉及。

update_time

Integer

参数解释:更新时间。

取值范围:不涉及。

id

String

参数解释:实验ID。

取值范围:不涉及。

表6 TrainingExperimentStatistic

参数

参数类型

描述

job_count

Integer

参数解释:当前实验下的训练作业总个数。

取值范围:不涉及。

请求示例

创建实验。

POST https://{endpoint}/v2/{project_id}/training-experiments

{
  "metadata" : {
    "name" : "test",
    "description" : "demo",
    "workspace_id" : "0"
  }
}

响应示例

状态码:201

OK

{
  "metadata" : {
    "id" : "6ccc15e6-8a81-4d8e-8bee-53401d850639",
    "name" : "test",
    "description" : "demo",
    "create_time" : 1731552542622,
    "workspace_id" : "0",
    "update_time" : 1731552542000
  },
  "statistic" : {
    "job_count" : 0
  }
}

状态码

状态码

描述

201

OK

错误码

请参见错误码

相关文档