通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Projects - Train

  • 参考
Service:
Cognitive Services - Custom Vision
API Version:
3.3

将要训练的项目排队。

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/train
With optional parameters: 
POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/train?trainingType={trainingType}&reservedBudgetInHours={reservedBudgetInHours}&forceTrain={forceTrain}&notificationEmailAddress={notificationEmailAddress}

URI 参数

名称 在 必需 类型 说明
Endpoint
 path True

string

支持的认知服务终结点。
projectId
 path True

string

uuid

项目 ID。
forceTrain
 query

boolean

即使数据集和配置未更改，是否强制训练 (默认值：false) 。
notificationEmailAddress
 query

string

训练完成时要向其发送通知的电子邮件地址 (默认值：null) 。
reservedBudgetInHours
 query

integer

int32

预留为培训 (预算的小时数（如果适用) ）。
trainingType
 query

string

用于训练项目的训练类型 (默认值：常规) 。

请求头

Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

名称 必需 类型 说明
Training-Key True

string

请求正文

Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

名称 类型 说明
selectedTags

string[]

为此训练会话选择的标记列表，项目中的其他标记将被忽略。

响应

名称 类型 说明
200 OK

Iteration

确定

Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes

CustomVisionError

错误响应

Media Types: "application/json", "application/xml", "text/xml"

安全性

Training-Key

Type: apiKey
In: header

示例

Successful TrainProject request

Sample Request

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/train


{}

Sample Response

Status code:
200 
{
  "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
  "name": "Iteration 2",
  "status": "Training",
  "created": "2017-12-18T22:40:36Z",
  "lastModified": "2017-12-19T15:46:58Z",
  "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
  "exportable": false,
  "domainId": null,
  "exportableTo": [
    "ONNX",
    "DockerFile",
    "TensorFlow",
    "CoreML"
  ],
  "trainingType": "Regular",
  "reservedBudgetInHours": 0,
  "publishName": ""
}

定义

名称 说明
Classifier

获取项目的分类类型。
CustomVisionError
CustomVisionErrorCodes

错误代码。
ExportableTo

此迭代可以导出到的一组平台。
Iteration

要通过 JSON 发送的迭代模型。
TrainingParameters

用于训练的参数。
TrainingType

获取迭代的训练类型。

Classifier

获取项目的分类类型。

名称 类型 说明
Multiclass

string

Multilabel

string

CustomVisionError

名称 类型 说明
code

CustomVisionErrorCodes

错误代码。
message

string

解释服务报告的错误的消息。

CustomVisionErrorCodes

错误代码。

名称 类型 说明
BadRequest

string

BadRequestCannotMigrateProjectWithName

string

BadRequestClassificationTrainingValidationFailed

string

BadRequestCustomerManagedKeyRevoked

string

BadRequestDetectionTrainingNotAllowNegativeTag

string

BadRequestDetectionTrainingValidationFailed

string

BadRequestDomainNotSupportedForAdvancedTraining

string

BadRequestExceedIterationPerProjectLimit

string

BadRequestExceedProjectLimit

string

BadRequestExceedTagPerImageLimit

string

BadRequestExceedTagPerProjectLimit

string

BadRequestExceededBatchSize

string

BadRequestExceededQuota

string

BadRequestExportAlreadyInProgress

string

BadRequestExportPlatformNotSupportedForAdvancedTraining

string

BadRequestExportValidationFailed

string

BadRequestExportWhileTraining

string

BadRequestImageBatch

string

BadRequestImageDimensions

string

BadRequestImageExceededCount

string

BadRequestImageFormat

string

BadRequestImageMetadataKey

string

BadRequestImageMetadataValue

string

BadRequestImageRegions

string

BadRequestImageSizeBytes

string

BadRequestImageStream

string

BadRequestImageTags

string

BadRequestImageUrl

string

BadRequestInvalid

string

BadRequestInvalidArtifactUri

string

BadRequestInvalidEmailAddress

string

BadRequestInvalidIds

string

BadRequestInvalidImportToken

string

BadRequestInvalidPublishName

string

BadRequestInvalidPublishTarget

string

BadRequestIterationDescription

string

BadRequestIterationIsNotTrained

string

BadRequestIterationIsPublished

string

BadRequestIterationName

string

BadRequestIterationNameNotUnique

string

BadRequestIterationNotPublished

string

BadRequestIterationValidationFailed

string

BadRequestMultiClassClassificationTrainingValidationFailed

string

BadRequestMultiLabelClassificationTrainingValidationFailed

string

BadRequestMultipleGeneralProductTag

string

BadRequestMultipleNegativeTag

string

BadRequestNegativeAndRegularTagOnSameImage

string

BadRequestNotLimitedTrial

string

BadRequestNotSupported

string

BadRequestOperationNotSupported

string

BadRequestPredictionIdsExceededCount

string

BadRequestPredictionIdsMissing

string

BadRequestPredictionInvalidApplicationName

string

BadRequestPredictionInvalidQueryParameters

string

BadRequestPredictionResultsExceededCount

string

BadRequestPredictionTagsExceededCount

string

BadRequestProjectDescription

string

BadRequestProjectDuplicated

string

BadRequestProjectImagePreprocessingSettings

string

BadRequestProjectName

string

BadRequestProjectNameNotUnique

string

BadRequestProjectUnknownClassification

string

BadRequestProjectUnknownDomain

string

BadRequestProjectUnsupportedDomainTypeChange

string

BadRequestProjectUnsupportedExportPlatform

string

BadRequestRequiredParamIsNull

string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining

string

BadRequestSubscriptionApi

string

BadRequestTagDescription

string

BadRequestTagName

string

BadRequestTagNameNotUnique

string

BadRequestTagType

string

BadRequestTrainingAlreadyInProgress

string

BadRequestTrainingNotNeeded

string

BadRequestTrainingNotNeededButTrainingPipelineUpdated

string

BadRequestTrainingValidationFailed

string

BadRequestUnpublishFailed

string

BadRequestUnsupportedDomain

string

BadRequestWorkspaceCannotBeModified

string

BadRequestWorkspaceNotDeletable

string

Conflict

string

ConflictInvalid

string

ErrorExporterInvalidClassifier

string

ErrorExporterInvalidFeaturizer

string

ErrorExporterInvalidPlatform

string

ErrorFeaturizationAugmentationError

string

ErrorFeaturizationAugmentationUnavailable

string

ErrorFeaturizationInvalidFeaturizer

string

ErrorFeaturizationQueueTimeout

string

ErrorFeaturizationServiceUnavailable

string

ErrorFeaturizationUnrecognizedJob

string

ErrorInvalid

string

ErrorIterationCopyFailed

string

ErrorPrediction

string

ErrorPredictionModelNotCached

string

ErrorPredictionModelNotFound

string

ErrorPredictionServiceUnavailable

string

ErrorPredictionStorage

string

ErrorPreparePerformanceMigrationFailed

string

ErrorProjectExportRequestFailed

string

ErrorProjectImportRequestFailed

string

ErrorProjectInvalidDomain

string

ErrorProjectInvalidPipelineConfiguration

string

ErrorProjectInvalidWorkspace

string

ErrorProjectTrainingRequestFailed

string

ErrorRegionProposal

string

ErrorUnknown

string

ErrorUnknownBaseModel

string

Forbidden

string

ForbiddenDRModeEnabled

string

ForbiddenInvalid

string

ForbiddenUser

string

ForbiddenUserDisabled

string

ForbiddenUserDoesNotExist

string

ForbiddenUserInsufficientCapability

string

ForbiddenUserResource

string

ForbiddenUserSignupAllowanceExceeded

string

ForbiddenUserSignupDisabled

string

NoError

string

NotFound

string

NotFoundApimSubscription

string

NotFoundDomain

string

NotFoundImage

string

NotFoundInvalid

string

NotFoundIteration

string

NotFoundIterationPerformance

string

NotFoundProject

string

NotFoundProjectDefaultIteration

string

NotFoundTag

string

UnsupportedMediaType

string

ExportableTo

此迭代可以导出到的一组平台。

名称 类型 说明
CoreML

string

DockerFile

string

ONNX

string

TensorFlow

string

VAIDK

string

Iteration

要通过 JSON 发送的迭代模型。

名称 类型 说明
classificationType

Classifier

获取项目的分类类型。
created

string

获取此迭代完成的时间。
domainId

string

获取或设置已训练迭代的域的 GUID。
exportable

boolean

迭代是否可以导出为另一种格式以供下载。
exportableTo

ExportableTo[]

此迭代可以导出到的一组平台。
id

string

获取迭代的 ID。
lastModified

string

获取上次修改此迭代的时间。
name

string

获取或设置迭代的名称。
originalPublishResourceId

string

此迭代最初发布到的资源提供程序 ID。
projectId

string

获取迭代的项目 ID。
publishName

string

已发布模型的名称。
reservedBudgetInHours

integer

获取迭代的保留高级训练预算。
status

string

获取当前迭代状态。
trainedAt

string

获取上次修改此迭代的时间。
trainingTimeInMinutes

integer

获取迭代的训练时间。
trainingType

TrainingType

获取迭代的训练类型。

TrainingParameters

用于训练的参数。

名称 类型 说明
selectedTags

string[]

为此训练会话选择的标记列表，项目中的其他标记将被忽略。

TrainingType

获取迭代的训练类型。

名称 类型 说明
Advanced

string

Regular

string