Projects - Train

Reference

Service:: Azure AI Services

API Version:: 3.3

Queues project for training.

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 Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints.
projectId	path	True	string uuid	The project id.
forceTrain	query		boolean	Whether to force train even if dataset and configuration does not change (default: false).
notificationEmailAddress	query		string	The email address to send notification to when training finishes (default: null).
reservedBudgetInHours	query		integer int32	The number of hours reserved as budget for training (if applicable).
trainingType	query		string	The type of training to use to train the project (default: Regular).

Request Header

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

Name	Required	Type	Description
Training-Key	True	string

Request Body

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

Name	Type	Description
selectedTags	string[]	List of tags selected for this training session, other tags in the project will be ignored.

Responses

Name	Type	Description
200 OK	Iteration	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Error response Media Types: "application/json", "application/xml", "text/xml"

Name

Type

Description

200 OK

Iteration

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

Other Status Codes

CustomVisionError

Error response

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

Security

Training-Key

Type: apiKey
In: header

Examples

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

Definitions

Name	Description
Classifier	Gets the classification type of the project.
CustomVisionError
CustomVisionErrorCodes	The error code.
ExportableTo	A set of platforms this iteration can export to.
Iteration	Iteration model to be sent over JSON.
TrainingParameters	Parameters used for training.
TrainingType	Gets the training type of the iteration.

Classifier

Enumeration

Gets the classification type of the project.

Value	Description
Multiclass
Multilabel

CustomVisionError

Object

Name	Type	Description
code	CustomVisionErrorCodes	The error code.
message	string	A message explaining the error reported by the service.

CustomVisionErrorCodes

Enumeration

The error code.

Value	Description
BadRequest
BadRequestCannotMigrateProjectWithName
BadRequestClassificationTrainingValidationFailed
BadRequestCustomerManagedKeyRevoked
BadRequestDetectionTrainingNotAllowNegativeTag
BadRequestDetectionTrainingValidationFailed
BadRequestDomainNotSupportedForAdvancedTraining
BadRequestExceedIterationPerProjectLimit
BadRequestExceedProjectLimit
BadRequestExceedTagPerImageLimit
BadRequestExceedTagPerProjectLimit
BadRequestExceededBatchSize
BadRequestExceededQuota
BadRequestExportAlreadyInProgress
BadRequestExportPlatformNotSupportedForAdvancedTraining
BadRequestExportValidationFailed
BadRequestExportWhileTraining
BadRequestImageBatch
BadRequestImageDimensions
BadRequestImageExceededCount
BadRequestImageFormat
BadRequestImageMetadataKey
BadRequestImageMetadataValue
BadRequestImageRegions
BadRequestImageSizeBytes
BadRequestImageStream
BadRequestImageTags
BadRequestImageUrl
BadRequestInvalid
BadRequestInvalidArtifactUri
BadRequestInvalidEmailAddress
BadRequestInvalidIds
BadRequestInvalidImportToken
BadRequestInvalidPublishName
BadRequestInvalidPublishTarget
BadRequestIterationDescription
BadRequestIterationIsNotTrained
BadRequestIterationIsPublished
BadRequestIterationName
BadRequestIterationNameNotUnique
BadRequestIterationNotPublished
BadRequestIterationValidationFailed
BadRequestMultiClassClassificationTrainingValidationFailed
BadRequestMultiLabelClassificationTrainingValidationFailed
BadRequestMultipleGeneralProductTag
BadRequestMultipleNegativeTag
BadRequestNegativeAndRegularTagOnSameImage
BadRequestNotLimitedTrial
BadRequestNotSupported
BadRequestOperationNotSupported
BadRequestPredictionIdsExceededCount
BadRequestPredictionIdsMissing
BadRequestPredictionInvalidApplicationName
BadRequestPredictionInvalidQueryParameters
BadRequestPredictionResultsExceededCount
BadRequestPredictionTagsExceededCount
BadRequestProjectDescription
BadRequestProjectDuplicated
BadRequestProjectImagePreprocessingSettings
BadRequestProjectName
BadRequestProjectNameNotUnique
BadRequestProjectUnknownClassification
BadRequestProjectUnknownDomain
BadRequestProjectUnsupportedDomainTypeChange
BadRequestProjectUnsupportedExportPlatform
BadRequestRequiredParamIsNull
BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining
BadRequestSubscriptionApi
BadRequestTagDescription
BadRequestTagName
BadRequestTagNameNotUnique
BadRequestTagType
BadRequestTrainingAlreadyInProgress
BadRequestTrainingNotNeeded
BadRequestTrainingNotNeededButTrainingPipelineUpdated
BadRequestTrainingValidationFailed
BadRequestUnpublishFailed
BadRequestUnsupportedDomain
BadRequestWorkspaceCannotBeModified
BadRequestWorkspaceNotDeletable
Conflict
ConflictInvalid
ErrorExporterInvalidClassifier
ErrorExporterInvalidFeaturizer
ErrorExporterInvalidPlatform
ErrorFeaturizationAugmentationError
ErrorFeaturizationAugmentationUnavailable
ErrorFeaturizationInvalidFeaturizer
ErrorFeaturizationQueueTimeout
ErrorFeaturizationServiceUnavailable
ErrorFeaturizationUnrecognizedJob
ErrorInvalid
ErrorIterationCopyFailed
ErrorPrediction
ErrorPredictionModelNotCached
ErrorPredictionModelNotFound
ErrorPredictionServiceUnavailable
ErrorPredictionStorage
ErrorPreparePerformanceMigrationFailed
ErrorProjectExportRequestFailed
ErrorProjectImportRequestFailed
ErrorProjectInvalidDomain
ErrorProjectInvalidPipelineConfiguration
ErrorProjectInvalidWorkspace
ErrorProjectTrainingRequestFailed
ErrorRegionProposal
ErrorUnknown
ErrorUnknownBaseModel
Forbidden
ForbiddenDRModeEnabled
ForbiddenInvalid
ForbiddenUser
ForbiddenUserDisabled
ForbiddenUserDoesNotExist
ForbiddenUserInsufficientCapability
ForbiddenUserResource
ForbiddenUserSignupAllowanceExceeded
ForbiddenUserSignupDisabled
NoError
NotFound
NotFoundApimSubscription
NotFoundDomain
NotFoundImage
NotFoundInvalid
NotFoundIteration
NotFoundIterationPerformance
NotFoundProject
NotFoundProjectDefaultIteration
NotFoundTag
UnsupportedMediaType

ExportableTo

Enumeration

A set of platforms this iteration can export to.

Value	Description
CoreML
DockerFile
ONNX
TensorFlow
VAIDK

Iteration

Object

Iteration model to be sent over JSON.

Name	Type	Description
classificationType	Classifier	Gets the classification type of the project.
created	string	Gets the time this iteration was completed.
domainId	string	Get or sets a guid of the domain the iteration has been trained on.
exportable	boolean	Whether the iteration can be exported to another format for download.
exportableTo	ExportableTo[]	A set of platforms this iteration can export to.
id	string	Gets the id of the iteration.
lastModified	string	Gets the time this iteration was last modified.
name	string	Gets or sets the name of the iteration.
originalPublishResourceId	string	Resource Provider Id this iteration was originally published to.
projectId	string	Gets the project id of the iteration.
publishName	string	Name of the published model.
reservedBudgetInHours	integer	Gets the reserved advanced training budget for the iteration.
status	string	Gets the current iteration status.
trainedAt	string	Gets the time this iteration was last modified.
trainingTimeInMinutes	integer	Gets the training time for the iteration.
trainingType	TrainingType	Gets the training type of the iteration.

TrainingParameters

Object

Parameters used for training.

Name	Type	Description
selectedTags	string[]	List of tags selected for this training session, other tags in the project will be ignored.

TrainingType

Enumeration

Gets the training type of the iteration.

Value	Description
Advanced
Regular

Condividi tramite

Projects - Train

URI Parameters

Request Header

Request Body

Responses

Security

Training-Key

Examples

Successful TrainProject request

Sample request

Sample response

Definitions

Classifier

CustomVisionError

CustomVisionErrorCodes

ExportableTo

Iteration

TrainingParameters

TrainingType

Risorse aggiuntive