1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
创建训练任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTrainingJob。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
AlgorithmSpecification | 是 | AlgorithmSpecification | 算法镜像配置 |
OutputDataConfig | 是 | OutputDataConfig | 输出数据配置 |
ResourceConfig | 是 | ResourceConfig | 资源实例配置 |
TrainingJobName | 是 | String | 训练任务名称 |
InputDataConfig.N | 否 | Array of InputDataConfig | 输入数据配置 |
StoppingCondition | 否 | StoppingCondition | 中止条件 |
VpcConfig | 否 | VpcConfig | 私有网络配置 |
HyperParameters | 否 | String | 算法超级参数 |
EnvConfig.N | 否 | Array of EnvConfig | 环境变量配置 |
RoleName | 否 | String | 角色名称 |
RetryWhenResourceInsufficient | 否 | String | 在资源不足(ResourceInsufficient)时后台不定时尝试重新创建训练任务。可取值Enabled/Disabled 默认值为Disabled即不重新尝试。设为Enabled时重新尝试有一定的时间期限,定义在 StoppingCondition 中 MaxWaitTimeInSecond中 ,默认值为1天,超过该期限创建失败。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TrainingJobName | String | 训练任务名称 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建一个训练任务
输入示例
https://tione.tencentcloudapi.com/?Action=CreateTrainingJob
&TrainingJobName=test
&HyperParameters={"learning_rate":1.0}
&AlgorithmSpecification.TrainingImageName=ccr.ccs.tencentyun.com/ti_public/tensorflow:1.14.0-py3
&AlgorithmSpecification.TrainingInputMode=File
&OutputDataConfig.CosOutputBucket=bucket
&OutputDataConfig.CosOutputKeyPrefix=test
&ResourceConfig.InstanceCount=1
&ResourceConfig.InstanceType=TI.SMALL2.1core2g
&ResourceConfig.VolumeSizeInGB=10
&InputDataConfig.0.ChannelName=train
&InputDataConfig.0.DataSource.CosDataSource.Bucket=bucket
&InputDataConfig.0.DataSource.CosDataSource.KeyPrefix=test
&InputDataConfig.0.InputMode=File
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "89719e50-4e38-4287-9205-00afcf4dd780",
"TrainingJobName": "test"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ClsServiceNotActived | 尚未开通CLS日志服务,请开前往开通。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.DuplicateName | 实例名称冲突,请更换名称后重试。 |
InvalidParameterValue.FileSystemNeedVpcConfigSupport | 文件系统作为训练数据源时需要指定VPC配置。 |
InvalidParameterValue.FileSystemNumLimit | 文件系统超过限额,最大为2。 |
InvalidParameterValue.FileSystemVpcNotMatch | 文件系统的vpc必须和任务的vpc相同。 |
InvalidParameterValue.FrameworkVersionNotSupport | 训练框架对应的版本不支持,请阅读文档查看TIONE目前支持的框架和版本。 |
InvalidParameterValue.ImageNotFound | 训练任务镜像不存在。 |
InvalidParameterValue.InvalidInstanceType | 无效的资源类型,支持的资源类型参考:https://cloud.tencent.com/document/product/851/41239。 |
InvalidParameterValue.InvalidTrainingImageName | 训练任务镜像名称无效。 |
InvalidParameterValue.MpiProcessesPerHostTooMuch | MPI分布式任务参数ti_mpi_num_of_processes_per_host不能超过GPU卡数。 |
InvalidParameterValue.SubnetNotFound | 子网不存在。 |
InvalidParameterValue.TrainCodeNotFound | 训练代码不存在或无效。 |
LimitExceeded | 超过配额限制。 |
ResourceInsufficient | 资源不足。 |
ResourceUnavailable | 资源不可用。 |