停止训练任务接口StopTrainTask的语法及示例_视觉智能开放平台(VIAPI)-阿里云帮助中心

功能描述

根据训练任务ID停止正在训练中的训练任务。

说明

您可以进入在线咨询获取在线人工帮助。
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。

接入指引

1. 注册阿里云账号：打开阿里云官网，在阿里云官网右上角，单击立即注册，按照操作提示完成账号注册。

2. 开通能力：请确保您已开通自学习服务，若未开通服务请立即开通。

说明自学习服务将于2024年9月30日起停止提供服务，已开通服务的老用户可以在2024年9月30日前通过视觉智能开放平台控制台正常访问，新用户将不再支持开通该服务。如需继续使用类似自学习的服务，请前往人工智能平台PAI重新训练模型。

3. 创建AccessKey：请确保您已创建AccessKey，如果您使用的是子账号AccessKey，您需要给子账号赋予AliyunVIAPIFullAccess权限，具体操作，请参见RAM授权。

4. 在线调试（可选）：您可以通过OpenAPI Explorer在线调试能力，查看完整的调用示例代码及SDK依赖信息，也可以下载完整的工程。

5. 开发接入步骤：

在SDK总览中选择您要接入使用的SDK语言。
在对应语言的SDK文档中找到AI类目为自学习（viapi-regen）类目的SDK包进行安装。
参考文档中提供的示例代码进行适当修改后调用。

6. 客户端直接调用：该能力常用的客户端调用方式包括以下几种。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	StopTrainTask	系统规定参数。取值：StopTrainTask。
Id	Long	是	68	训练任务ID。

返回数据

名称	类型	示例值	描述
RequestId	String	E4CD2E3E-4484-08E7-9FBA-087D49FA95BD	每个请求分配唯一的服务器请求ID。
Data	Object		出参数据实体。
Id	Long	68	服务ID。
GmtCreate	Long	1634106778000	创建时间。
TaskName	String	test3	任务名称。
Description	String	test3	任务描述。
DatasetId	Long	120	数据集ID。
DatasetName	String	test1	数据集名称。
LabelId	Long	228	标注ID。
LabelName	String	test3	标注名称。
TrainMode	String	COMMON	训练模型。取值如下： COMMON：均衡 HIGH_ACC：高精度 HIGH_PERF：高性能
TrainStatus	String	TRAIN_FAIL	训练状态。取值如下： INIT：未训练 PREPARING：准备中 TRAINING：训练中 TRAIN_SUCCESS：训练成功 TRAIN_FAIL：训练失败
ModelId	Long	123	模型ID。
ModelEffect	String	[{"id": "TOP1_ACC", "name": "top1准确率", "value": 100.0}, {"id": "TOP5_ACC", "name": "top5准确率", "value": 100.0}]	模型效果。

SDK参考

阿里云视觉AI自学习类目下的停止训练任务接口能力推荐使用SDK调用，支持多种编程语言，调用时请选择AI类目为自学习（viapi-regen）的SDK包，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见SDK总览。

示例

请求示例

http(s)://viapi-regen.cn-shanghai.aliyuncs.com/?Action=StopTrainTask     //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&Id=68
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<StopTrainTaskResponse>
    <RequestId>E4CD2E3E-4484-08E7-9FBA-087D49FA95BD</RequestId>
    <Data>
        <Id>68</Id>
        <GmtCreate>1634106778000</GmtCreate>
        <TaskName>test3</TaskName>
        <Description>test3</Description>
        <DatasetId>120</DatasetId>
        <DatasetName>test1</DatasetName>
        <LabelId>228</LabelId>
        <LabelName>test3</LabelName>
        <TrainMode>COMMON</TrainMode>
        <TrainStatus>TRAIN_FAIL</TrainStatus>
        <ModelId>123</ModelId>
        <ModelEffect>[{"id": "TOP1_ACC", "name": "top1准确率", "value": 100.0}, {"id": "TOP5_ACC", "name": "top5准确率", "value": 100.0}]</ModelEffect>
    </Data>
</StopTrainTaskResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E4CD2E3E-4484-08E7-9FBA-087D49FA95BD",
  "Data" : {
    "Id" : 68,
    "GmtCreate" : 1634106778000,
    "TaskName" : "test3",
    "Description" : "test3",
    "DatasetId" : 120,
    "DatasetName" : "test1",
    "LabelId" : 228,
    "LabelName" : "test3",
    "TrainMode" : "COMMON",
    "TrainStatus" : "TRAIN_FAIL",
    "ModelId" : 123,
    "ModelEffect" : "[{\"id\": \"TOP1_ACC\", \"name\": \"top1准确率\", \"value\": 100.0}, {\"id\": \"TOP5_ACC\", \"name\": \"top5准确率\", \"value\": 100.0}]"
  }
}

错误码

关于停止训练任务的错误码，详情请参见常见错误码。

安全声明

请确保上传的图片或文件来源符合相应的法律法规。
通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。