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 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點。
projectId	path	True	string uuid	項目標識碼。
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"

名稱	必要	類型	Description
Training-Key	True	string

要求本文

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

名稱	類型	Description
selectedTags	string[]	針對此訓練會話選取的標籤清單，將會忽略專案中的其他標記。

回應

名稱	類型	Description
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

HTTP

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": ""
}

定義

名稱	Description
Classifier	取得項目的分類類型。
CustomVisionError
CustomVisionErrorCodes	錯誤碼。
ExportableTo	這個反覆專案可以匯出至的一組平臺。
Iteration	要透過 JSON 傳送的反覆專案模型。
TrainingParameters	用於定型的參數。
TrainingType	取得反覆專案的定型類型。

Classifier

取得項目的分類類型。

名稱	類型	Description
Multiclass	string
Multilabel	string

CustomVisionError

名稱	類型	Description
code	CustomVisionErrorCodes	錯誤碼。
message	string	說明服務所報告錯誤的訊息。

CustomVisionErrorCodes

錯誤碼。

名稱	類型	Description
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

這個反覆專案可以匯出至的一組平臺。

名稱	類型	Description
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string

Iteration

要透過 JSON 傳送的反覆專案模型。

名稱	類型	Description
classificationType	Classifier	取得項目的分類類型。
created	string	取得這個反覆專案完成的時間。
domainId	string	取得或設定已定型反覆專案之網域的 GUID。
exportable	boolean	是否可以將反覆項目匯出為另一種格式進行下載。
exportableTo	ExportableTo[]	這個反覆專案可以匯出至的一組平臺。
id	string	取得反覆項目的標識碼。
lastModified	string	取得上次修改此反覆項目的時間。
name	string	取得或設定反覆項目的名稱。
originalPublishResourceId	string	資源提供者識別碼此反覆專案最初發佈至 。
projectId	string	取得反覆專案的專案標識碼。
publishName	string	已發佈模型的名稱。
reservedBudgetInHours	integer	取得反覆運算的保留進階定型預算。
status	string	取得目前的反覆項目狀態。
trainedAt	string	取得上次修改此反覆項目的時間。
trainingTimeInMinutes	integer	取得反覆專案的定型時間。
trainingType	TrainingType	取得反覆專案的定型類型。

TrainingParameters

用於定型的參數。

名稱	類型	Description
selectedTags	string[]	針對此訓練會話選取的標籤清單，將會忽略專案中的其他標記。

TrainingType

取得反覆專案的定型類型。

名稱	類型	Description
Advanced	string
Regular	string