Train Project - Train Project
Met en file d’attente le projet pour en effectuer l’apprentissage.
POST {Endpoint}/customvision/v3.4-preview/training/projects/{projectId}/trainPOST {Endpoint}/customvision/v3.4-preview/training/projects/{projectId}/train?trainingType={trainingType}&reservedBudgetInHours={reservedBudgetInHours}&forceTrain={forceTrain}¬ificationEmailAddress={notificationEmailAddress}Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Points de terminaison Cognitive Services pris en charge. |
|
project
|
path | True |
string (uuid) |
ID du projet. |
|
force
|
query |
boolean |
Indique s’il faut forcer l’apprentissage même si le jeu de données et la configuration ne changent pas (valeur par défaut : false). |
|
|
notification
|
query |
string |
Adresse e-mail à laquelle envoyer une notification lorsque l’entraînement se termine (valeur par défaut : null). |
|
|
reserved
|
query |
integer (int32) |
Nombre d’heures réservées en tant que budget pour la formation (le cas échéant). |
|
|
training
|
query |
string |
Type d’entraînement à utiliser pour entraîner le projet (par défaut : normal). |
En-tête de la demande
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| Training-Key | True |
string |
Corps de la demande
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Nom | Type | Description |
|---|---|---|
| customBaseModelInfo |
Informations sur l’itération précédemment entraînée qui fournit le modèle de base pour l’entraînement de l’itération actuelle. |
|
| selectedTags |
string[] (uuid) |
La liste des balises sélectionnées pour cette session d’entraînement, les autres balises du projet seront ignorées. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
D’ACCORD Media Types: "application/json", "application/xml", "text/xml" |
|
| Other Status Codes |
Réponse d’erreur Media Types: "application/json", "application/xml", "text/xml" |
Sécurité
Training-Key
Type:
apiKey
Dans:
header
Exemples
Successful TrainProject request
Exemple de requête
POST https://westus.api.cognitive.microsoft.com/customvision/v3.4-preview/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/train
{}
Exemple de réponse
{
"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": ""
}Définitions
| Nom | Description |
|---|---|
| Classifier |
Obtient le type de classification du projet. |
|
Custom |
|
|
Custom |
|
|
Custom |
Code d’erreur. |
|
Exportable |
Un ensemble de plateformes vers lesquelles cette itération peut être exportée. |
| Iteration |
Modèle d’itération à envoyer via JSON. |
|
Training |
Paramètres utilisés pour l’entraînement. |
|
Training |
Obtient le type d’entraînement de l’itération. |
Classifier
Obtient le type de classification du projet.
| Valeur | Description |
|---|---|
| Multiclass | |
| Multilabel |
CustomBaseModelInfo
| Nom | Type | Description |
|---|---|---|
| iterationId |
string (uuid) |
ID d’itération du projet précédemment formé à utiliser pour l’entraînement de l’itération actuelle. |
| projectId |
string (uuid) |
ID de projet du projet précédemment formé à utiliser pour l’entraînement de l’itération actuelle. |
CustomVisionError
| Nom | Type | Description |
|---|---|---|
| code |
Code d’erreur. |
|
| message |
string |
Message expliquant l’erreur signalée par le service. |
CustomVisionErrorCodes
Code d’erreur.
| Valeur | 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 | |
| BadRequestImageAspectRatio | |
| BadRequestImageExceededCount | |
| BadRequestTrainingNotNeeded | |
| BadRequestTrainingNotNeededButTrainingPipelineUpdated | |
| BadRequestTrainingValidationFailed | |
| BadRequestClassificationTrainingValidationFailed | |
| BadRequestMultiClassClassificationTrainingValidationFailed | |
| BadRequestMultiLabelClassificationTrainingValidationFailed | |
| BadRequestDetectionTrainingValidationFailed | |
| BadRequestTrainingAlreadyInProgress | |
| BadRequestDetectionTrainingNotAllowNegativeTag | |
| BadRequestInvalidEmailAddress | |
| BadRequestRetiredDomainNotSupportedForTraining | |
| BadRequestDomainNotSupportedForAdvancedTraining | |
| BadRequestExportPlatformNotSupportedForAdvancedTraining | |
| BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining | |
| BadRequestCustomBaseModelIterationStatusNotCompleted | |
| BadRequestCustomBaseModelDomainNotCompatible | |
| BadRequestCustomBaseModelArchitectureRetired | |
| BadRequestExportValidationFailed | |
| BadRequestExportAlreadyInProgress | |
| BadRequestPredictionIdsMissing | |
| BadRequestPredictionIdsExceededCount | |
| BadRequestPredictionTagsExceededCount | |
| BadRequestPredictionResultsExceededCount | |
| BadRequestPredictionInvalidApplicationName | |
| BadRequestPredictionInvalidQueryParameters | |
| BadRequestInvalidImportToken | |
| BadRequestExportWhileTraining | |
| BadRequestImageMetadataKey | |
| BadRequestImageMetadataValue | |
| BadRequestOperationNotSupported | |
| BadRequestInvalidArtifactUri | |
| BadRequestCustomerManagedKeyRevoked | |
| BadRequestInvalidUri | |
| 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 | |
| ErrorServerTimeOut | |
| ErrorInvalid |
ExportableTo
Un ensemble de plateformes vers lesquelles cette itération peut être exportée.
| Valeur | Description |
|---|---|
| CoreML | |
| TensorFlow | |
| DockerFile | |
| ONNX | |
| VAIDK | |
| OpenVino |
Iteration
Modèle d’itération à envoyer via JSON.
| Nom | Type | Description |
|---|---|---|
| classificationType |
Obtient le type de classification du projet. |
|
| created |
string (date-time) |
Obtient le moment où cette itération a été terminée. |
| customBaseModelInfo |
Informations sur l’itération précédemment entraînée qui fournit le modèle de base pour l’entraînement de l’itération actuelle. La valeur par défaut de null spécifie qu’aucune itération précédemment formée n’est utilisée pour l’apprentissage incrémentiel. |
|
| domainId |
string (uuid) |
Obtient ou définit un guid du domaine sur lequel l’itération a été formée. |
| exportable |
boolean |
Indique si l’itération peut être exportée vers un autre format de téléchargement. |
| exportableTo |
Un ensemble de plateformes vers lesquelles cette itération peut être exportée. |
|
| id |
string (uuid) |
Obtient l’ID de l’itération. |
| lastModified |
string (date-time) |
Obtient l’heure à laquelle cette itération a été modifiée pour la dernière fois. |
| name |
string |
Obtient ou définit le nom de l’itération. |
| originalPublishResourceId |
string |
ID du fournisseur de ressources dans cette itération a été publiée à l’origine. |
| projectId |
string (uuid) |
Obtient l’ID de projet de l’itération. |
| publishName |
string |
Nom du modèle publié. |
| reservedBudgetInHours |
integer (int32) |
Obtient le budget d’entraînement avancé réservé pour l’itération. |
| status |
string |
Obtient l’état actuel de l’itération. |
| trainedAt |
string (date-time) |
Obtient l’heure à laquelle cette itération a été modifiée pour la dernière fois. |
| trainingErrorDetails |
string |
Détails de l’erreur d’entraînement, en cas d’échec de l’entraînement. La valeur est null lorsque l’entraînement réussit. |
| trainingTimeInMinutes |
integer (int32) |
Obtient le temps d’entraînement de l’itération. |
| trainingType |
Obtient le type d’entraînement de l’itération. |
TrainingParameters
Paramètres utilisés pour l’entraînement.
| Nom | Type | Description |
|---|---|---|
| customBaseModelInfo |
Informations sur l’itération précédemment entraînée qui fournit le modèle de base pour l’entraînement de l’itération actuelle. |
|
| selectedTags |
string[] (uuid) |
La liste des balises sélectionnées pour cette session d’entraînement, les autres balises du projet seront ignorées. |
TrainingType
Obtient le type d’entraînement de l’itération.
| Valeur | Description |
|---|---|
| Regular | |
| Advanced |