获取模型压缩任务详情
更新时间:2024-10-10
功能介绍
本接口用于获取模型压缩任务详情。
SDK调用
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js 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"
resp = resources.Model.V2.describe_model_comp_task(model_comp_task_id="amva-5v3zxxxxp")
print(resp.body)
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/model",
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
"DescribeModelCompTask",
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]interface{}{
"modelCompTaskId":"amva-abciuctdx15t",
})
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/model")
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
.action("DescribeModelCompTask")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"modelCompTaskId","amva-abciuctdx15t"
))
.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/model', action: 'DescribeModelCompTask', data: {
"modelCompTaskId":"amva-abciuctdx15t"
}
});
console.log(res);
}
main();
返回示例
{
'requestId': '942192dc-0ce3-41de-abd4-e1c69cef8277',
'result': {
'id': 'amva-5v3zbk9wi8rp',
'name': 'da_comp_test',
'description': '',
'status': 'running',
'sourceModelId': 'amv-3cyk3wrm8379',
'modelId': 'amv-jhf4x5tsevin',
'config': {
'strategy': 'Quantization',
'weight': 'INT8-PTQ'
},
'createTime': '2024-07-10T14:46:32+08:00'
}
}
{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"id": "amva-abciuctdx15t",
"name": "demo",
"description": "test",
"state": "Done",
"failedReason": "",
"sourceModelId": "amv-se1t8i4gr9fu",
"targetModelId": "amv-vnhxxj3crnsp",
"createTime": "2024-04-10T17:16:22+08:00",
"finishTime": "2024-04-10T17:36:22+08:00",
"config": {
"strategy": "Quantization",
"weight": "wint8"
}
}
}
{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"id": "amva-abciuctdx15t",
"name": "demo",
"description": "test",
"state": "Done",
"failedReason": "",
"sourceModelId": "amv-se1t8i4gr9fu",
"targetModelId": "amv-vnhxxj3crnsp",
"createTime": "2024-04-10T17:16:22+08:00",
"finishTime": "2024-04-10T17:36:22+08:00",
"config": {
"strategy": "Quantization",
"weight": "wint8"
}
}
}
{
requestId: '6ba7b810-9dad-11dxxxfd430c8',
result: {
id: 'amva-abciuctdx15t',
name: 'demo',
description: 'test',
state: 'Done',
failedReason: '',
sourceModelId: 'amv-se1t8i4gr9fu',
targetModelId: 'amv-vnhxxj3crnsp',
createTime: '2024-04-10T17:16:22+08:00',
finishTime: '2024-04-10T17:36:22+08:00',
config": {
strategy: 'Quantization',
weight: 'wint8'
}
}
}
请求参数
注意:以下为Python SDK参数说明,Go SDK、Java SDK、Node.js SDK参数说明请参考本文HTTP调用-请求说明。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
model_comp_task_id | string | 否 | 模型压缩任务id,可以通过以下任一方式获取该字段值: 方式一:通过调用创建模型压缩任务接口,返回的result字段获取 方式二:通过调用查看模型压缩任务列表接口,返回的id字段获取 |
返回参数
请参考本文HTTP调用-响应说明。
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址: https://qianfan.baidubce.com/v2/model
请求方式: POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 否 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值DescribeModelCompTask |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
modelCompTaskId | string | 否 | 模型压缩任务id,可以通过以下任一方式获取该字段值: 方式一:通过调用创建模型压缩任务接口,返回的result字段获取 方式二:通过调用查看模型压缩任务列表接口,返回的id字段获取 |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
id | string | 模型压缩任务id |
name | string | 模型压缩任务名称 |
description | string | 模型压缩任务描述 |
status | string | 模型压缩任务运行状态,取值: · creating:创建中 · running:运行中 · succeeded:已完成 · failed:已失败 · stopping:终止中 · stopped:已终止 |
failedReason | string | 模型压缩任务运行失败原因 |
sourceModelId | string | 模型压缩任务源模型版本id |
modelId | string | 压缩后产出模型版本id,仅当status为succeeded时,返回该字段 |
config | object | 模型压缩策略配置信息 |
createTime | string | 模型压缩任务创建时间 |
finishTime | string | 模型压缩任务完成时间 |
config说明
名称 | 类型 | 描述 |
---|---|---|
strategy | string | 模型压缩策略,说明: · Quantization:量化压缩策略 · Sparsity:稀疏化压缩策略 |
sparsityRatio | float | 稀疏比例,strategy为Sparsity时返回 |
weight | string | 量化压缩配置,说明: (1)当strategy为Quantization时,返回该字段 (2)说明: · WINT8 · INT8-PTQ · W8A16C16 · W4A16C16 |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/v2/model?Action=DescribeModelCompTask'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f4xxxxx6e374525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"modelCompTaskId":"amva-abciuctdx15t"
}'
响应示例
{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"id": "amva-abciuctdx15t",
"name": "demo",
"description": "test",
"state": "Done",
"failedReason": "",
"sourceModelId": "amv-se1t8i4gr9fu",
"targetModelId": "amv-vnhxxj3crnsp",
"createTime": "2024-04-10T17:16:22+08:00",
"finishTime": "2024-04-10T17:36:22+08:00",
"config": {
"strategy": "Quantization",
"weight": "wint8"
}
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。