更新训练实验信息 - ChangeTrainingExperiment
功能介绍
更新训练实验信息接口用于修改ModelArts平台上已存在的训练实验的配置。
该接口适用于以下场景：当用户需要调整训练实验的参数，如实验名称、描述时，可以通过此接口更新训练实验的信息。使用该接口的前提条件是用户已登录ModelArts平台并具有修改训练实验的权限，同时需要提供有效的实验ID和待更新的配置信息。更新操作完成后，系统将根据新的配置信息调整训练实验的设置。若实验ID无效、配置信息不合法或用户无权限操作，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。获取该接口关联的CLI示例： hcloud ModelArts ChangeTrainingExperiment。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
PUT /v2/{project_id}/training-experiments/{experiment_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
experiment_id |
是 |
String |
参数解释：训练实验ID。在训练作业创建时获取实验ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数解释：训练实验名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
description |
否 |
String |
参数解释：训练实验描述。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释：训练实验名称。 取值范围：不涉及。 |
|
description |
String |
参数解释：训练实验描述。 取值范围：不涉及。 |
请求示例
更新名称和描述信息。
PUT https://{endpoint}/v2/{project_id}/training-experiments/fa412c98-6d94-42a2-891a-99cd1da93916
{
"name" : "name",
"description" : "description"
}
响应示例
状态码：200
OK
{
"name" : "name",
"description" : "description"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
