获取模型精调任务详情
更新时间:2024-11-20
功能介绍
用于获取模型精调任务详情。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
SDK调用
调用示例
import os
from qianfan import resources
# 使用安全认证AK/SK鉴权,通过环境变量方式初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
# 获取模型精调任务详情
task_detail_resp = resources.FineTune.V2.task_detail(task_id="task-2jsxxx0i9a")
print(task_detail_resp)
package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
ca := qianfan.NewConsoleAction()
res, err := ca.Call(context.TODO(),
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
"/v2/finetuning",
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
"DescribeFineTuningTask",
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]interface{}{
"taskId":"task-0tgmn4a7h4i6",
})
if err != nil {
panic(err)
}
fmt.Println(string(res.Body))
}
import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;
public class Dome {
public static void main(String args[]){
// 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
ConsoleResponse<Map<String, Object>> response = qianfan.console()
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
.route("/v2/finetuning")
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
.action("DescribeFineTuningTask")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"taskId","task-0tgmn4a7h4i6"
))
.execute();
System.out.println(Json.serialize(response));
}
}
import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
async function main() {
//base_api_route:调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
//action:调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
//data:对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
const res = await consoleAction({base_api_route: '/v2/finetuning', action: 'DescribeFineTuningTask', data: {
"taskId":"task-0tgmn4a7h4i6"
}
});
console.log(res);
}
main();
返回示例
QfResponse(code = 200, headers = {
...
},
body = {
'requestId': '84d2448b-4ee8-457f-ac06-ec14xxxda',
'result':
{
'createTime': '2024-02-29T08:29:17Z',
'finishTime': '0000-00-00T00:00:00Z',
'jobDescription': 'ebspxxxxasks',
'jobId': 'job-6ucxjxxx8q0',
'jobName': 'job1',
'model': 'ERNIE-Speed',
'parameterScale': 'FullFineTuning',
'runProgress': '34%',
'runStatus': 'Running',
'taskId': 'task-2jsxxxx0i9a',
'trainMode': 'SFT',
'vdlLink': 'https://console.bce.baidu.com/qianfan/visualdl/index?displayToken=eyJydW5JxxxxDMxd3Q4ZXVjIn0='
}
}
)
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"taskId":"task-0tgmn4a7h4i6",
"jobId":"job-ftp4icwebtnc",
"jobName":"job-name",
"jobDescription":"job-description",
"model":"ERNIE-Speed-8K",
"trainMode":"SFT",
"parameterScale":"FullFineTuning",
"runStatus":"Running",
"runProgress":"99%",
"vdlLink":"https://console.bce.baidu.com/qianfan/visualdl/index?displayToken=eyJydW5JZCI6InJ1bi10NGczZmZuMXpzampwZHFzIn0="
"createTime":"2024-01-16T09:48:35Z",
"finishTime":"2024-01-16T10:48:35Z"
}
}
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"taskId":"task-0tgmn4a7h4i6",
"jobId":"job-ftp4icwebtnc",
"jobName":"job-name",
"jobDescription":"job-description",
"model":"ERNIE-Speed-8K",
"trainMode":"SFT",
"parameterScale":"FullFineTuning",
"runStatus":"Running",
"runProgress":"99%",
"vdlLink":"https://console.bce.baidu.com/qianfan/visualdl/index?displayToken=eyJydW5JZCI6InJ1bi10NGczZmZuMXpzampwZHFzIn0="
"createTime":"2024-01-16T09:48:35Z",
"finishTime":"2024-01-16T10:48:35Z"
}
}
{
requestId:'1bef3f87-c5b2-4419-xxx4f10d4',
result:{
taskId:'task-0tgmn4a7h4i6',
jobId:'job-ftp4icwebtnc',
jobName:'job-name',
jobDescription:'job-description',
model:'ERNIE-Speed-8K',
trainMode:'SFT',
parameterScale:'FullFineTuning',
runStatus:'Running',
runProgress:'99%',
vdlLink:'https://console.bce.baidu.com/qianfan/visualdl/index?displayToken=eyJydW5JZCI6InJ1bixxxxxHFzIn0='
createTime:'2024-01-16T09:48:35Z',
finishTime:'2024-01-16T10:48:35Z'
}
}
请求参数
注意:不同语言SDK的请求参数不同,请根据实际调用选择对应参数。
- Python SDK请求参数说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
task_id | string | 是 | 任务ID,可以通过以下方法获取该字段,以SFT为例说明: 在控制台-模型精调列表页面,点击某个训练任务详情,在任务详情信息页查看,如下图所示: |
- 其它SDK请求参数说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
taskId | string | 是 | 任务ID,可以通过以下方法获取该字段,以SFT为例说明: 在控制台-模型精调列表页面,点击某个训练任务详情,在任务详情信息页查看,如下图所示: |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
taskId | string | 任务ID |
jobId | string | 作业ID |
jobName | string | 作业名称 |
jobDescription | string | 作业描述 |
model | string | 基础模型版本 |
trainMode | string | 调优的训练模式 |
parameterScale | string | 调优的参数规模 |
runStatus | string | 任务运行状态,说明: · Running: 运行中 · Done: 运行完成 · Stopped: 运行中止 · Failed: 运行失败 · Waiting:排队中 |
runProgress | string | 训练进度,说明:只有任务运行状态运行中,才会返回此参数,即runStatus为Running时,返回该参数 |
vdlLink | string | 训练可视化链接 |
metrics | object | 评估指标,运行完成才会返回,目前只支持文本生成类型 |
checkpointList | List<checkpointItem> | checkpoint信息 |
createTime | string | 任务创建时间 |
finishTime | string | 任务结束时间 |
errorMessage | string | 错误讯息 |
errorCode | int | 错误码 |
metrics说明
名称 | 类型 | 描述 |
---|---|---|
BLEU-4 | string | 评估指标BLEU-4 |
ROUGE-1 | string | 评估指标ROUGE-1 |
ROUGE-2 | string | 评估指标ROUGE-2 |
ROUGE-L | string | 评估指标ROUGE-L |
checkpointItem说明
名称 | 类型 | 描述 |
---|---|---|
step | int | step |
perplexity | float | perplexity |
trainingLoss | float | trainingLoss |