1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
导入模型
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTrainingModel。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ImportMethod | 是 | String | 导入方式 MODEL:导入新模型 VERSION:导入新版本 EXIST:导入现有版本 示例值:a1 |
ReasoningEnvironmentSource | 是 | String | 推理环境来源(SYSTEM/CUSTOM) 示例值:a2 |
TrainingModelName | 否 | String | 模型名称,不超过60个字符,仅支持中英文、数字、下划线"_"、短横"-",只能以中英文、数字开头 示例值:a2 |
Tags.N | 否 | Array of Tag | 标签配置 |
TrainingJobName | 否 | String | 训练任务名称 |
TrainingModelCosPath | 否 | CosPathInfo | 模型来源cos目录,以/结尾 示例值:a2 |
AlgorithmFramework | 否 | String | 算法框架 (PYTORCH/TENSORFLOW/DETECTRON2/PMML/MMDETECTION) 示例值:a2 |
ReasoningEnvironment | 否 | String | 推理环境 示例值:a2 |
TrainingModelIndex | 否 | String | 训练指标,最多支持1000字符 示例值:a2 |
TrainingModelVersion | 否 | String | 模型版本 示例值:a2 |
ReasoningImageInfo | 否 | ImageInfo | 自定义推理环境 |
ModelMoveMode | 否 | String | 模型移动方式(CUT/COPY) 示例值:a2 |
TrainingJobId | 否 | String | 训练任务ID 示例值:a2 |
TrainingModelId | 否 | String | 模型ID(导入新模型不需要,导入新版本需要) 示例值:id |
ModelOutputPath | 否 | CosPathInfo | 模型存储cos目录 示例值:a2 |
TrainingModelSource | 否 | String | 模型来源 (JOB/COS) 示例值:JOB |
TrainingPreference | 否 | String | 模型偏好 示例值:BALANCE |
AutoMLTaskId | 否 | String | 自动学习任务ID(已废弃) 示例值:rodftv7u3gg |
TrainingJobVersion | 否 | String | 任务版本 示例值:v3 |
ModelVersionType | 否 | String | 模型版本类型; 枚举值:NORMAL(通用) ACCELERATE(加速) 注意: 默认为NORMAL 示例值:ACCELERATE |
ModelFormat | 否 | String | 模型格式 (PYTORCH/TORCH_SCRIPT/DETECTRON2/SAVED_MODEL/FROZEN_GRAPH/PMML/MMDETECTION/ONNX/HUGGING_FACE) 示例值:SAVED_MODEL |
ReasoningEnvironmentId | 否 | String | 推理镜像ID 示例值:tensorflow2.4-py38(gpu) |
AutoClean | 否 | String | 模型自动清理开关(true/false),当前版本仅支持SAVED_MODEL格式模型 示例值:false |
MaxReservedModels | 否 | Integer | 模型数量保留上限(默认值为24个,上限为24,下限为1,步长为1) 示例值:24 |
ModelCleanPeriod | 否 | Integer | 模型清理周期(默认值为1分钟,上限为1440,下限为1分钟,步长为1) 示例值:1 |
IsQAT | 否 | Boolean | 是否QAT模型 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Id | String | 模型ID,TrainingModel ID 示例值:a1 |
TrainingModelVersionId | String | 模型版本ID 示例值:mv-23131231 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 导入模型请求
导入模型请求
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTrainingModel
<公共请求参数>
{
"TrainingJobName": "test-job",
"TrainingJobId": "train-608753141184489472",
"TrainingModelVersion": "v1",
"Tags": [
{
"TagKey": "test-key",
"TagValue": "test-value"
}
],
"ModelMoveMode": "COPY",
"TrainingModelIndex": "test123",
"ReasoningEnvironment": "tione.tencentcloudcr.com/qcloud-ti-platform/ti-cloud-infer-pytorch-gpu:py38-torch1.9.0-cu111-tiacc3.0.0-2.0.2",
"ReasoningEnvironmentId": "pytorch1.9.0-py38(gpu)",
"TrainingModelName": "test-model",
"AlgorithmFramework": "PYTORCH",
"ImportMethod": "MODEL",
"ReasoningEnvironmentSource": "SYSTEM",
"TrainingModelCosPath": {
"Paths": [
"test/output/train-608753141184489472/model/"
],
"Region": "ap-guangzhou",
"Bucket": "test-bucket"
}
}
输出示例
{
"Response": {
"Id": "m-664968589676184576",
"RequestId": "ced11c16-fd5a-4f12-8a0b-17c7f0b14659",
"TrainingModelVersionId": "mv-v1-664975193381340160"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.CamException | CAM系统异常。 |
AuthFailure.UnauthorizedOperation | 未授权操作。 |
FailedOperation | 操作失败。 |
FailedOperation.BindingTagsFailed | 绑定标签失败。 |
FailedOperation.ExecDatabaseFail | 数据库执行错误。 |
FailedOperation.ExecTagFail | 标签操作失败。 |
FailedOperation.MoveModelDirFailed | 移动模型目录失败。 |
FailedOperation.QueryDatabaseFail | 数据库查询错误。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
UnknownParameter | 未知参数错误。 |