查询、取消、删除调优任务,以及查询调优任务日志。
适用范围
- 适用地域:本文描述的功能仅在华北2(北京)地域可用,且必须使用该地域的API Key。
- 已成功获取 API Key并配置到环境变量。
- 已通过创建调优任务接口创建了调优任务。
查询调优任务状态
查询指定调优任务的详细信息和运行状态。
地址
请求示例
请求参数
字段 | 类型 | 传参方式 | 必选 | 描述 |
|---|---|---|---|---|
job_id | String | Url Path | 是 | 要查询的调优任务的ID。即创建调优任务返回参数中的job_id。 |
响应示例
- 文本生成模型
- 视频生成模型
- 图像生成模型
响应参数
参数名称 | 类型 | 参数说明 |
|---|---|---|
request_id | String | 本次请求的ID。 |
output | Object | 调优任务的详细信息。 |
output.job_id | String | 本次调优的任务ID,用于后续查询状态。 生成规则: |
output.jobs_name | String | 同 |
output.status | String | 本次调优任务的状态。 |
output.finetuned_output | String | 仅调优任务状态为“SUCCEED”时出现,返回的是调优完成的模型ID。 |
output.model | String | 调优任务使用的模型ID。 |
output.base_model | String | 调优任务使用的模型对应的基础模型ID。 比如:调优任务 |
output.training_file_ids | Array | 兼容字段,新任务始终返回空数组,请使用 training_datasets。 |
output.validation_file_ids | Array | 兼容字段,新任务始终返回空数组,请使用 validation_datasets。 |
output.training_datasets | Array of Dataset | 训练数据集列表。 |
output.validation_datasets | Array of Dataset | 测试数据集列表。 |
output.hyper_parameters | Object | 显性声明过的超参表。 |
output.training_type | String | 调优方法。 |
output.create_time | String | 调优任务创建时间。 |
output.workspace_id | String | 调优任务所属的业务空间ID。 |
output.user_identity | String | 该调优任务隶属的主账号UID。 |
output.modifier | String | 对该调优任务进行最后一次操作的账号UID。(比如:某个子账号取消了该任务,该子账号UID会显示在这里) |
output.creator | String | 该调优任务创建人UID。 |
output.end_time | String | 调优任务结束时间,当任务状态为“SUCCEED”、“FAILED”、“CANCELED”时出现。 |
output.group | String | 模型调优的任务类型。 |
output.usage | Integer | 调优任务消耗的Token(count)数,扣费计算公式请参考:计费说明。当任务状态为“SUCCEED”、“CANCELED”时出现。 |
output.output_cnt | Integer | 当前任务已产出的 Checkpoint 数量。仅对支持多 Checkpoint 输出的模型(如 |
output.max_output_cnt | Integer | 单次任务可产出的 Checkpoint 数量上限。 |
取消调优任务
取消正在运行的调优任务。仅处于运行中状态的任务可被取消。
地址
请求示例
请求参数
字段 | 类型 | 传参方式 | 必选 | 描述 |
|---|---|---|---|---|
job_id | String | Url Path | 是 | 要取消的调优任务ID,可通过创建训练任务或列举训练任务接口获取。 |
响应示例
响应参数
参数名称 | 类型 | 参数说明 |
|---|---|---|
request_id | String | 本次请求的ID。 |
output | Object | 取消操作返回的详细信息。 |
删除调优任务
删除指定的调优任务记录。
地址
请求示例
请求参数
字段 | 类型 | 传参方式 | 必选 | 描述 |
|---|---|---|---|---|
job_id | String | Url Path | 是 | 要删除的调优任务ID,可通过创建训练任务或列举训练任务接口获取。 |
响应示例
响应参数
参数名称 | 类型 | 参数说明 |
|---|---|---|
request_id | String | 本次请求的ID。 |
output | Object | 删除操作返回的详细信息。 |
查询调优任务列表
分页查询当前账号下的调优任务列表。
地址
请求示例
请求参数
参数名称 | 类型 | 传参方式 | 是否必填 | 参数说明 |
|---|---|---|---|---|
page_no | Integer | Query | 否 | 默认1 |
page_size | Integer | Query | 否 | 默认10,最大值1000,最小值1 |
model | String | Query | 否 | 模型ID,指定该参数表示只列举基于该模型的调优任务 |
响应示例
响应参数
| 参数名称 | 类型 | 参数说明 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| request_id | String | 本次请求的ID。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| output | Object | 查询返回的详细信息。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| output.page_no | Integer | 页码。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| output.page_size | Integer | 每页显示的数据量。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| output.total | Integer | 调优任务总计数量。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| output.jobs | Array | 多个调优任务详情。
点击此处查看调优任务详情对象
|
查询调优任务日志
查询指定调优任务的训练日志。
地址
请求示例
请求参数
字段 | 类型 | 传参方式 | 必选 | 描述 |
|---|---|---|---|---|
job_id | String | Url Path | 是 | 要打印日志的调优任务ID,可通过创建训练任务或列举训练任务接口获取。 |
offset | Number | Query | 否 | 忽略前 |
line | Number | Query | 否 | 从 |
响应示例
响应参数
参数名称 | 类型 | 参数说明 |
|---|---|---|
request_id | String | 本次请求的ID。 |
output | Object | 查询返回的详细信息。 |
output.total | Integer | 日志总计行数。 |
output.logs | Array | 输出的日志。 |
异常响应
响应示例
响应参数
字段 | 类型 | 描述 | 示例值 |
|---|---|---|---|
code | String | 错误码。 | NotFound |
request_id | String | 本次请求的系统唯一码。 | 6332fb02-3111-43f0-bf79-f9e8c5ffa7f9 |
message | String | 错误信息。 | Not Found! |
HTTP状态码 | 错误码 | 错误信息举例 | 含义 | 处理方式 |
|---|---|---|---|---|
400 | InvalidParameter | Missing training files | 参数错误,缺少参数或者参数格式问题等。 | 根据错误信息,修正您的参数。 |
400 | UnsupportedOperation | The fine-tune job can not be canceled because it is succeeded or failed | 当资源处于特定状态时,无法对其进行操作。 | 待要操作的资源到达可操作状态时再进行操作。 |
400 | UnsupportedOperation | The fine-tune job can not be deleted because it is succeeded,failed or canceled | 当资源处于特定状态时,无法对其进行操作。 | 待要操作的资源到达可操作状态时再进行操作。 |
404 | NotFound | Not found! | 要查询/操作的资源不存在。 | 检查要查询/操作的资源ID是否错误。 |
409 | Conflict | Model instance xxxxx already exists, please specify a suffix | 已存在deployed_model名为xxxxx的部署实例,需要指定后缀进行区分。 | 为部署指定唯一的后缀。 |
429 | Throttling |
| 资源的创建触发平台限制。 |
|
500 | InternalError | Internal server error! | 内部错误。 | 记录 request_id,通过工单联系阿里云工程师进行排查。 |