Projects - Train

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Reiht das Projekt für das Training in eine Warteschlange ein.

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte.
projectId	path	True	string uuid	Die Projekt-ID.
forceTrain	query		boolean	Gibt an, ob das Trainieren erzwungen werden soll, auch wenn sich das Dataset und die Konfiguration nicht ändern (Standard: false).
notificationEmailAddress	query		string	Die E-Mail-Adresse, an die nach Abschluss des Trainings eine Benachrichtigung gesendet werden soll (Standard: NULL).
reservedBudgetInHours	query		integer int32	Die Anzahl der als Budget für die Schulung reservierten Stunden (falls zutreffend).
trainingType	query		string	Die Art der Schulung, die zum Trainieren des Projekts verwendet werden soll (Standard: Normal).

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
Training-Key	True	string

Anforderungstext

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

Name	Typ	Beschreibung
selectedTags	string[]	Liste der für diese Trainingssitzung ausgewählten Tags, andere Tags im Projekt werden ignoriert.

Antworten

Name	Typ	Beschreibung
200 OK	Iteration	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Fehlerantwort Media Types: "application/json", "application/xml", "text/xml"

Sicherheit

Training-Key

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
Classifier	Ruft den Klassifizierungstyp des Projekts ab.
CustomVisionError
CustomVisionErrorCodes	Der Fehlercode.
ExportableTo	Eine Reihe von Plattformen, auf die diese Iteration exportiert werden kann.
Iteration	Iterationsmodell, das über JSON gesendet werden soll.
TrainingParameters	Für das Training verwendete Parameter.
TrainingType	Ruft den Trainingstyp der Iteration ab.

Classifier

Ruft den Klassifizierungstyp des Projekts ab.

Name	Typ	Beschreibung
Multiclass	string
Multilabel	string

CustomVisionError

Name	Typ	Beschreibung
code	CustomVisionErrorCodes	Der Fehlercode.
message	string	Eine Meldung, die den vom Dienst gemeldeten Fehler erklärt.

CustomVisionErrorCodes

Der Fehlercode.

Name	Typ	Beschreibung
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

Eine Reihe von Plattformen, auf die diese Iteration exportiert werden kann.

Name	Typ	Beschreibung
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string

Iteration

Iterationsmodell, das über JSON gesendet werden soll.

Name	Typ	Beschreibung
classificationType	Classifier	Ruft den Klassifizierungstyp des Projekts ab.
created	string	Ruft den Zeitpunkt ab, zu dem diese Iteration abgeschlossen wurde.
domainId	string	Rufen Sie eine GUID der Domäne ab, für die die Iteration trainiert wurde, oder legt sie fest.
exportable	boolean	Gibt an, ob die Iteration zum Herunterladen in ein anderes Format exportiert werden kann.
exportableTo	ExportableTo[]	Eine Reihe von Plattformen, auf die diese Iteration exportiert werden kann.
id	string	Ruft die ID der Iteration ab.
lastModified	string	Ruft den Zeitpunkt ab, zu dem diese Iteration zuletzt geändert wurde.
name	string	Ruft den Namen der Iteration ab oder legt den Namen fest.
originalPublishResourceId	string	Ressourcenanbieter-ID, für die diese Iteration ursprünglich veröffentlicht wurde.
projectId	string	Ruft die Projekt-ID der Iteration ab.
publishName	string	Name des veröffentlichten Modells.
reservedBudgetInHours	integer	Ruft das reservierte Budget für erweiterte Schulungen für die Iteration ab.
status	string	Ruft die aktuelle Iteration status ab.
trainedAt	string	Ruft den Zeitpunkt ab, zu dem diese Iteration zuletzt geändert wurde.
trainingTimeInMinutes	integer	Ruft die Trainingszeit für die Iteration ab.
trainingType	TrainingType	Ruft den Trainingstyp der Iteration ab.

TrainingParameters

Für das Training verwendete Parameter.

Name	Typ	Beschreibung
selectedTags	string[]	Liste der für diese Trainingssitzung ausgewählten Tags, andere Tags im Projekt werden ignoriert.

TrainingType

Ruft den Trainingstyp der Iteration ab.

Name	Typ	Beschreibung
Advanced	string
Regular	string