Projects - Train

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Projekt kolejek do trenowania.

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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services.
projectId	path	True	string uuid	Identyfikator projektu.
forceTrain	query		boolean	Czy wymusić trenowanie, nawet jeśli zestaw danych i konfiguracja nie zmieni się (wartość domyślna: false).
notificationEmailAddress	query		string	Adres e-mail, do który ma być wysyłane powiadomienie po zakończeniu trenowania (wartość domyślna: null).
reservedBudgetInHours	query		integer int32	Liczba godzin zarezerwowanych jako budżet na szkolenie (jeśli dotyczy).
trainingType	query		string	Typ trenowania używanego do trenowania projektu (domyślnie: Regular).

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Training-Key	True	string

Treść żądania

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

Nazwa	Typ	Opis
selectedTags	string[]	Lista tagów wybranych dla tej sesji szkoleniowej, inne tagi w projekcie zostaną zignorowane.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Iteration	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Odpowiedź na błąd Media Types: "application/json", "application/xml", "text/xml"

Zabezpieczenia

Training-Key

Type: apiKey
In: header

Przykłady

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

Definicje

Nazwa	Opis
Classifier	Pobiera typ klasyfikacji projektu.
CustomVisionError
CustomVisionErrorCodes	Kod błędu.
ExportableTo	Zestaw platform, do których ta iteracja może być eksportowana.
Iteration	Model iteracji, który ma być wysyłany za pośrednictwem formatu JSON.
TrainingParameters	Parametry używane do trenowania.
TrainingType	Pobiera typ trenowania iteracji.

Classifier

Pobiera typ klasyfikacji projektu.

Nazwa	Typ	Opis
Multiclass	string
Multilabel	string

CustomVisionError

Nazwa	Typ	Opis
code	CustomVisionErrorCodes	Kod błędu.
message	string	Komunikat wyjaśniający błąd zgłoszony przez usługę.

CustomVisionErrorCodes

Kod błędu.

Nazwa	Typ	Opis
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

Zestaw platform, do których ta iteracja może być eksportowana.

Nazwa	Typ	Opis
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string

Iteration

Model iteracji, który ma być wysyłany za pośrednictwem formatu JSON.

Nazwa	Typ	Opis
classificationType	Classifier	Pobiera typ klasyfikacji projektu.
created	string	Pobiera czas ukończenia tej iteracji.
domainId	string	Pobierz lub ustawia identyfikator GUID domeny, na których została wytrenowana iteracja.
exportable	boolean	Czy iteracji można wyeksportować do innego formatu do pobrania.
exportableTo	ExportableTo[]	Zestaw platform, do których ta iteracja może być eksportowana.
id	string	Pobiera identyfikator iteracji.
lastModified	string	Pobiera czas ostatniej modyfikacji tej iteracji.
name	string	Pobiera lub ustawia nazwę iteracji.
originalPublishResourceId	string	Identyfikator dostawcy zasobów, dla którego ta iteracja została pierwotnie opublikowana.
projectId	string	Pobiera identyfikator projektu iteracji.
publishName	string	Nazwa opublikowanego modelu.
reservedBudgetInHours	integer	Pobiera zarezerwowany zaawansowany budżet szkoleniowy dla iteracji.
status	string	Pobiera bieżący stan iteracji.
trainedAt	string	Pobiera czas ostatniej modyfikacji tej iteracji.
trainingTimeInMinutes	integer	Pobiera czas trenowania iteracji.
trainingType	TrainingType	Pobiera typ trenowania iteracji.

TrainingParameters

Parametry używane do trenowania.

Nazwa	Typ	Opis
selectedTags	string[]	Lista tagów wybranych dla tej sesji szkoleniowej, inne tagi w projekcie zostaną zignorowane.

TrainingType

Pobiera typ trenowania iteracji.

Nazwa	Typ	Opis
Advanced	string
Regular	string