Projects - Train
Projeto de filas para treinamento.
POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/train
POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/train?trainingType={trainingType}&reservedBudgetInHours={reservedBudgetInHours}&forceTrain={forceTrain}¬ificationEmailAddress={notificationEmailAddress}
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Pontos de extremidade de Serviços Cognitivos suportados. |
|
project
|
path | True |
string (uuid) |
O id do projeto. |
|
force
|
query |
boolean |
Se o treinamento deve ser forçado, mesmo que o conjunto de dados e a configuração não sejam alterados (padrão: false). |
|
|
notification
|
query |
string |
O endereço de e-mail para o qual enviar notificação quando o treinamento terminar (padrão: nulo). |
|
|
reserved
|
query |
integer (int32) |
O número de horas reservadas como orçamento para formação (se aplicável). |
|
|
training
|
query |
string |
O tipo de treinamento a ser usado para treinar o projeto (padrão: Regular). |
Cabeçalho do Pedido
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Training-Key | True |
string |
Corpo do Pedido
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Tipo | Description |
|---|---|---|
| selectedTags |
string[] (uuid) |
Lista de tags selecionadas para esta sessão de treinamento, outras tags no projeto serão ignoradas. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
OK Media Types: "application/json", "application/xml", "text/xml" |
|
| Other Status Codes |
Resposta de erro Media Types: "application/json", "application/xml", "text/xml" |
Segurança
Training-Key
Tipo:
apiKey
Em:
header
Exemplos
Successful TrainProject request
Pedido de amostra
POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/train
{}
Resposta da amostra
{
"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
| Name | Description |
|---|---|
| Classifier |
Obtém o tipo de classificação do projeto. |
|
Custom |
|
|
Custom |
O código de erro. |
|
Exportable |
Um conjunto de plataformas para as quais essa iteração pode ser exportada. |
| Iteration |
Modelo de iteração a ser enviado por JSON. |
|
Training |
Parâmetros utilizados para a formação. |
|
Training |
Obtém o tipo de treinamento da iteração. |
Classifier
Obtém o tipo de classificação do projeto.
| Valor | Description |
|---|---|
| Multiclass | |
| Multilabel |
CustomVisionError
| Name | Tipo | Description |
|---|---|---|
| code |
O código de erro. |
|
| message |
string |
Uma mensagem explicando o erro relatado pelo serviço. |
CustomVisionErrorCodes
O código de erro.
| Valor | Description |
|---|---|
| NoError | |
| BadRequest | |
| BadRequestExceededBatchSize | |
| BadRequestNotSupported | |
| BadRequestInvalidIds | |
| BadRequestProjectName | |
| BadRequestProjectNameNotUnique | |
| BadRequestProjectDescription | |
| BadRequestProjectUnknownDomain | |
| BadRequestProjectUnknownClassification | |
| BadRequestProjectUnsupportedDomainTypeChange | |
| BadRequestProjectUnsupportedExportPlatform | |
| BadRequestProjectImagePreprocessingSettings | |
| BadRequestProjectDuplicated | |
| BadRequestIterationName | |
| BadRequestIterationNameNotUnique | |
| BadRequestIterationDescription | |
| BadRequestIterationIsNotTrained | |
| BadRequestIterationValidationFailed | |
| BadRequestWorkspaceCannotBeModified | |
| BadRequestWorkspaceNotDeletable | |
| BadRequestTagName | |
| BadRequestTagNameNotUnique | |
| BadRequestTagDescription | |
| BadRequestTagType | |
| BadRequestMultipleNegativeTag | |
| BadRequestMultipleGeneralProductTag | |
| BadRequestImageTags | |
| BadRequestImageRegions | |
| BadRequestNegativeAndRegularTagOnSameImage | |
| BadRequestUnsupportedDomain | |
| BadRequestRequiredParamIsNull | |
| BadRequestIterationIsPublished | |
| BadRequestInvalidPublishName | |
| BadRequestInvalidPublishTarget | |
| BadRequestUnpublishFailed | |
| BadRequestIterationNotPublished | |
| BadRequestSubscriptionApi | |
| BadRequestExceedProjectLimit | |
| BadRequestExceedIterationPerProjectLimit | |
| BadRequestExceedTagPerProjectLimit | |
| BadRequestExceedTagPerImageLimit | |
| BadRequestExceededQuota | |
| BadRequestCannotMigrateProjectWithName | |
| BadRequestNotLimitedTrial | |
| BadRequestImageBatch | |
| BadRequestImageStream | |
| BadRequestImageUrl | |
| BadRequestImageFormat | |
| BadRequestImageSizeBytes | |
| BadRequestImageDimensions | |
| BadRequestImageExceededCount | |
| BadRequestTrainingNotNeeded | |
| BadRequestTrainingNotNeededButTrainingPipelineUpdated | |
| BadRequestTrainingValidationFailed | |
| BadRequestClassificationTrainingValidationFailed | |
| BadRequestMultiClassClassificationTrainingValidationFailed | |
| BadRequestMultiLabelClassificationTrainingValidationFailed | |
| BadRequestDetectionTrainingValidationFailed | |
| BadRequestTrainingAlreadyInProgress | |
| BadRequestDetectionTrainingNotAllowNegativeTag | |
| BadRequestInvalidEmailAddress | |
| BadRequestDomainNotSupportedForAdvancedTraining | |
| BadRequestExportPlatformNotSupportedForAdvancedTraining | |
| BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining | |
| BadRequestExportValidationFailed | |
| BadRequestExportAlreadyInProgress | |
| BadRequestPredictionIdsMissing | |
| BadRequestPredictionIdsExceededCount | |
| BadRequestPredictionTagsExceededCount | |
| BadRequestPredictionResultsExceededCount | |
| BadRequestPredictionInvalidApplicationName | |
| BadRequestPredictionInvalidQueryParameters | |
| BadRequestInvalidImportToken | |
| BadRequestExportWhileTraining | |
| BadRequestImageMetadataKey | |
| BadRequestImageMetadataValue | |
| BadRequestOperationNotSupported | |
| BadRequestInvalidArtifactUri | |
| BadRequestCustomerManagedKeyRevoked | |
| BadRequestInvalid | |
| UnsupportedMediaType | |
| Forbidden | |
| ForbiddenUser | |
| ForbiddenUserResource | |
| ForbiddenUserSignupDisabled | |
| ForbiddenUserSignupAllowanceExceeded | |
| ForbiddenUserDoesNotExist | |
| ForbiddenUserDisabled | |
| ForbiddenUserInsufficientCapability | |
| ForbiddenDRModeEnabled | |
| ForbiddenInvalid | |
| NotFound | |
| NotFoundProject | |
| NotFoundProjectDefaultIteration | |
| NotFoundIteration | |
| NotFoundIterationPerformance | |
| NotFoundTag | |
| NotFoundImage | |
| NotFoundDomain | |
| NotFoundApimSubscription | |
| NotFoundInvalid | |
| Conflict | |
| ConflictInvalid | |
| ErrorUnknown | |
| ErrorIterationCopyFailed | |
| ErrorPreparePerformanceMigrationFailed | |
| ErrorProjectInvalidWorkspace | |
| ErrorProjectInvalidPipelineConfiguration | |
| ErrorProjectInvalidDomain | |
| ErrorProjectTrainingRequestFailed | |
| ErrorProjectImportRequestFailed | |
| ErrorProjectExportRequestFailed | |
| ErrorFeaturizationServiceUnavailable | |
| ErrorFeaturizationQueueTimeout | |
| ErrorFeaturizationInvalidFeaturizer | |
| ErrorFeaturizationAugmentationUnavailable | |
| ErrorFeaturizationUnrecognizedJob | |
| ErrorFeaturizationAugmentationError | |
| ErrorExporterInvalidPlatform | |
| ErrorExporterInvalidFeaturizer | |
| ErrorExporterInvalidClassifier | |
| ErrorPredictionServiceUnavailable | |
| ErrorPredictionModelNotFound | |
| ErrorPredictionModelNotCached | |
| ErrorPrediction | |
| ErrorPredictionStorage | |
| ErrorRegionProposal | |
| ErrorUnknownBaseModel | |
| ErrorInvalid |
ExportableTo
Um conjunto de plataformas para as quais essa iteração pode ser exportada.
| Valor | Description |
|---|---|
| CoreML | |
| TensorFlow | |
| DockerFile | |
| ONNX | |
| VAIDK |
Iteration
Modelo de iteração a ser enviado por JSON.
| Name | Tipo | Description |
|---|---|---|
| classificationType |
Obtém o tipo de classificação do projeto. |
|
| created |
string (date-time) |
Obtém o tempo em que esta iteração foi concluída. |
| domainId |
string (uuid) |
Obtenha ou defina 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 |
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 esta 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 o qual esta 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 esta iteração foi modificada pela última vez. |
| trainingTimeInMinutes |
integer (int32) |
Obtém o tempo de treinamento para a iteração. |
| trainingType |
Obtém o tipo de treinamento da iteração. |
TrainingParameters
Parâmetros utilizados para a formação.
| Name | Tipo | Description |
|---|---|---|
| selectedTags |
string[] (uuid) |
Lista de tags selecionadas para esta sessão de treinamento, outras tags no projeto serão ignoradas. |
TrainingType
Obtém o tipo de treinamento da iteração.
| Valor | Description |
|---|---|
| Regular | |
| Advanced |