Projects - Train

Referência

Serviço:: Azure AI Services

Versão da API:: 3.3

Coloca na fila o projeto para treinamento.

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/train

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte.
projectId	path	True	string (uuid)	A ID do projeto.
forceTrain	query		boolean	Se o treinamento deve ser forçado mesmo se o conjunto de dados e a configuração não forem alterados (padrão: false).
notificationEmailAddress	query		string	O endereço de email para o qual enviar a notificação quando o treinamento for concluído (padrão: nulo).
reservedBudgetInHours	query		integer (int32)	O número de horas reservadas como orçamento para treinamento (se aplicável).
trainingType	query		string	O tipo de treinamento a ser usado para treinar o projeto (padrão: Regular).

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
Training-Key	True	string

Corpo da solicitação

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

Nome	Tipo	Description
selectedTags	string[] (uuid)	Lista de marcas selecionadas para esta sessão de treinamento, outras marcas no projeto serão ignoradas.

Respostas

Nome	Tipo	Description
200 OK	Iteration	OKEY Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Resposta de erro Media Types: "application/json", "application/xml", "text/xml"

Nome

Tipo

Description

200 OK

Iteration

OKEY

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

Other Status Codes

CustomVisionError

Resposta de erro

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

Segurança

Training-Key

Tipo: apiKey
Em: header

Exemplos

Successful TrainProject request

Solicitação de exemplo

HTTP

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


{}

Resposta de exemplo

Código de status:: 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": ""
}

Definições

Nome	Description
Classifier	Obtém o tipo de classificação do projeto.
CustomVisionError
CustomVisionErrorCodes	O código de erro.
ExportableTo	Um conjunto de plataformas para as quais essa iteração pode ser exportada.
Iteration	Modelo de iteração a ser enviado por JSON.
TrainingParameters	Parâmetros usados para treinamento.
TrainingType	Obtém o tipo de treinamento da iteração.

Classifier

Enumeração

Obtém o tipo de classificação do projeto.

Valor	Description
Multiclass
Multilabel

CustomVisionError

Objeto

Nome	Tipo	Description
code	CustomVisionErrorCodes	O código de erro.
message	string	Uma mensagem explicando o erro relatado pelo serviço.

CustomVisionErrorCodes

Enumeração

O código de erro.

Valor	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

Enumeração

Um conjunto de plataformas para as quais essa iteração pode ser exportada.

Valor	Description
CoreML
DockerFile
ONNX
TensorFlow
VAIDK

Iteration

Objeto

Modelo de iteração a ser enviado por JSON.

Nome	Tipo	Description
classificationType	Classifier	Obtém o tipo de classificação do projeto.
created	string (date-time)	Obtém a hora em que essa iteração foi concluída.
domainId	string (uuid)	Obtenha ou define um guid do domínio no qual a iteração foi treinada.
exportable	boolean	Se a iteração pode ser exportada para outro formato para download.
exportableTo	ExportableTo[]	Um conjunto de plataformas para as quais essa iteração pode ser exportada.
id	string (uuid)	Obtém a ID da iteração.
lastModified	string (date-time)	Obtém a hora em que essa iteração foi modificada pela última vez.
name	string	Obtém ou define o nome da iteração.
originalPublishResourceId	string	ID do Provedor de Recursos para a qual essa iteração foi originalmente publicada.
projectId	string (uuid)	Obtém a ID do projeto da iteração.
publishName	string	Nome do modelo publicado.
reservedBudgetInHours	integer (int32)	Obtém o orçamento de treinamento avançado reservado para a iteração.
status	string	Obtém o status da iteração atual.
trainedAt	string (date-time)	Obtém a hora em que essa iteração foi modificada pela última vez.
trainingTimeInMinutes	integer (int32)	Obtém o tempo de treinamento para a iteração.
trainingType	TrainingType	Obtém o tipo de treinamento da iteração.

TrainingParameters

Objeto

Parâmetros usados para treinamento.

Nome	Tipo	Description
selectedTags	string[] (uuid)	Lista de marcas selecionadas para esta sessão de treinamento, outras marcas no projeto serão ignoradas.

TrainingType

Enumeração

Obtém o tipo de treinamento da iteração.

Valor	Description
Advanced
Regular

Compartilhar via

Projects - Train

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Training-Key

Exemplos

Successful TrainProject request

Solicitação de exemplo

Resposta de exemplo

Definições

Classifier

CustomVisionError

CustomVisionErrorCodes

ExportableTo

Iteration

TrainingParameters

TrainingType