停止模型精调任务
更新时间:2024-11-05
注意: 为提升开发者使用体验,本文内容已合并至对应API文档,请查看API鉴权及调用-模型调优-模型调优V2-停止模型精调任务文档;本文档已于2024年6月28日在平台文档中心下线,内容不再更新。
功能介绍
用于停止模型精调任务。
使用说明
本文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"
# 停止模型精调任务
stop_resp=resources.FineTune.V2.stop_task(task_id="task-xxx")
print(stop_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
"StopFineTuningTask",
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]interface{}{
"taskId": "task-5kjifvzerc5n",
})
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("StopFineTuningTask")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"taskId", "task-5kjifvzerc5n"
))
.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: 'StopFineTuningTask', data: {
"taskId": "task-5kjifvzerc5n"
}
});
console.log(res);
}
main();
返回示例
QfResponse(code = 200, headers = {
...
}
, body = {
'requestId': '1c318587-3bfc-4f79-9854-74exxxa52'
, 'result': True
}
)
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":true
}
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":true
}
{
requestId:'1bef3f87-c5b2-xxxx9884f10d4',
result:true
}
请求参数
注意:不同语言SDK的请求参数不同,请根据实际调用选择对应参数。
- Python SDK请求参数说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
task_id | string | 是 | 任务ID,说明: (1)该参数只支持Post-pretrain、SFT的运行 (2)可以通过以下方法获取该字段,以SFT为例说明: 在控制台-模型精调列表页面,点击某个训练任务详情,在任务详情信息页查看,如下图所示: |
- 其它SDK请求参数说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
taskId | string | 是 | 任务ID,说明: (1)该参数只支持Post-pretrain、SFT的运行 (2)可以通过以下方法获取该字段,以SFT为例说明: 在控制台-模型精调列表页面,点击某个训练任务详情,在任务详情信息页查看,如下图所示: |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | bool | 请求结果 |