Projects - Train

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Pone en cola el proyecto para entrenamiento.

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos.
projectId	path	True	string uuid	Identificador del proyecto.
forceTrain	query		boolean	Si se fuerza el entrenamiento incluso si el conjunto de datos y la configuración no cambian (valor predeterminado: false).
notificationEmailAddress	query		string	Dirección de correo electrónico a la que se enviará la notificación cuando finalice el entrenamiento (valor predeterminado: null).
reservedBudgetInHours	query		integer int32	Número de horas reservadas como presupuesto para el entrenamiento (si procede).
trainingType	query		string	Tipo de entrenamiento que se va a usar para entrenar el proyecto (valor predeterminado: Normal).

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
Training-Key	True	string

Cuerpo de la solicitud

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

Nombre	Tipo	Description
selectedTags	string[]	Se omitirá la lista de etiquetas seleccionadas para esta sesión de entrenamiento; se omitirán otras etiquetas del proyecto.

Respuestas

Nombre	Tipo	Description
200 OK	Iteration	Aceptar Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Respuesta de error Media Types: "application/json", "application/xml", "text/xml"

Seguridad

Training-Key

Type: apiKey
In: header

Ejemplos

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

Definiciones

Nombre	Description
Classifier	Obtiene el tipo de clasificación del proyecto.
CustomVisionError
CustomVisionErrorCodes	Código de error.
ExportableTo	Un conjunto de plataformas a las que se puede exportar esta iteración.
Iteration	Modelo de iteración que se va a enviar a través de JSON.
TrainingParameters	Parámetros usados para el entrenamiento.
TrainingType	Obtiene el tipo de entrenamiento de la iteración.

Classifier

Obtiene el tipo de clasificación del proyecto.

Nombre	Tipo	Description
Multiclass	string
Multilabel	string

CustomVisionError

Nombre	Tipo	Description
code	CustomVisionErrorCodes	Código de error.
message	string	Mensaje que explica el error notificado por el servicio.

CustomVisionErrorCodes

Código de error.

Nombre	Tipo	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

Un conjunto de plataformas a las que se puede exportar esta iteración.

Nombre	Tipo	Description
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string

Iteration

Modelo de iteración que se va a enviar a través de JSON.

Nombre	Tipo	Description
classificationType	Classifier	Obtiene el tipo de clasificación del proyecto.
created	string	Obtiene la hora en que se completó esta iteración.
domainId	string	Obtiene o establece un guid del dominio en el que se ha entrenado la iteración.
exportable	boolean	Si la iteración se puede exportar a otro formato para su descarga.
exportableTo	ExportableTo[]	Un conjunto de plataformas a las que se puede exportar esta iteración.
id	string	Obtiene el identificador de la iteración.
lastModified	string	Obtiene la hora en que esta iteración se modificó por última vez.
name	string	Obtiene o establece el nombre de la iteración.
originalPublishResourceId	string	Identificador del proveedor de recursos en el que se publicó originalmente esta iteración.
projectId	string	Obtiene el identificador del proyecto de la iteración.
publishName	string	Nombre del modelo publicado.
reservedBudgetInHours	integer	Obtiene el presupuesto de entrenamiento avanzado reservado para la iteración.
status	string	Obtiene el estado de iteración actual.
trainedAt	string	Obtiene la hora en que esta iteración se modificó por última vez.
trainingTimeInMinutes	integer	Obtiene el tiempo de entrenamiento de la iteración.
trainingType	TrainingType	Obtiene el tipo de entrenamiento de la iteración.

TrainingParameters

Parámetros usados para el entrenamiento.

Nombre	Tipo	Description
selectedTags	string[]	Se omitirá la lista de etiquetas seleccionadas para esta sesión de entrenamiento; se omitirán otras etiquetas del proyecto.

TrainingType

Obtiene el tipo de entrenamiento de la iteración.

Nombre	Tipo	Description
Advanced	string
Regular	string