Projects - Train

Služba:

Cognitive Services - Custom Vision

Verze rozhraní API:

3.3

Projekt Fronty pro trénování.

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/train

S volitelnými parametry:

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/train?trainingType={trainingType}&reservedBudgetInHours={reservedBudgetInHours}&forceTrain={forceTrain}&notificationEmailAddress={notificationEmailAddress}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporované koncové body služeb Cognitive Services.
projectId	path	True	string uuid	ID projektu.
forceTrain	query		boolean	Jestli se má vynutit trénování, i když se nezmění datová sada a konfigurace (výchozí hodnota: false).
notificationEmailAddress	query		string	E-mailová adresa, na kterou se má odeslat oznámení, když se trénování dokončí (výchozí hodnota: null).
reservedBudgetInHours	query		integer int32	Počet hodin rezervovaných jako rozpočet pro trénování (pokud je k dispozici).
trainingType	query		string	Typ trénování, které se má použít k trénování projektu (výchozí nastavení: Normální).

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
Training-Key	True	string

Text požadavku

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

Name	Typ	Description
selectedTags	string[]	Seznam značek vybraných pro tuto trénovací relaci, ostatní značky v projektu budou ignorovány.

Odpovědi

Name	Typ	Description
200 OK	Iteration	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Odpověď na chybu Media Types: "application/json", "application/xml", "text/xml"

Zabezpečení

Training-Key

Typ: apiKey
V: header

Příklady

Successful TrainProject request

Ukázkový požadavek

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/train


{}

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Classifier	Získá typ klasifikace projektu.
CustomVisionError
CustomVisionErrorCodes	Kód chyby
ExportableTo	Sada platforem, na které může tato iterace exportovat.
Iteration	Model iterace, který se má odeslat přes JSON.
TrainingParameters	Parametry používané pro trénování
TrainingType	Získá typ trénování iterace.

Classifier

Získá typ klasifikace projektu.

Name	Typ	Description
Multiclass	string
Multilabel	string

CustomVisionError

Name	Typ	Description
code	CustomVisionErrorCodes	Kód chyby
message	string	Zpráva vysvětlující chybu nahlášenou službou.

CustomVisionErrorCodes

Kód chyby

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

Sada platforem, na které může tato iterace exportovat.

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

Iteration

Model iterace, který se má odeslat přes JSON.

Name	Typ	Description
classificationType	Classifier	Získá typ klasifikace projektu.
created	string	Získá čas dokončení této iterace.
domainId	string	Získejte nebo nastaví identifikátor GUID domény, na které byla iterace natrénována.
exportable	boolean	Jestli je možné iteraci exportovat do jiného formátu ke stažení.
exportableTo	ExportableTo[]	Sada platforem, na které může tato iterace exportovat.
id	string	Získá ID iterace.
lastModified	string	Získá čas, kdy byla tato iterace naposledy změněna.
name	string	Získá nebo nastaví název iterace.
originalPublishResourceId	string	ID poskytovatele prostředků, pro které byla tato iterace původně publikována.
projectId	string	Získá ID projektu iterace.
publishName	string	Název publikovaného modelu
reservedBudgetInHours	integer	Získá rezervovaný rozpočet pokročilého trénování pro iteraci.
status	string	Získá aktuální stav iterace.
trainedAt	string	Získá čas, kdy byla tato iterace naposledy změněna.
trainingTimeInMinutes	integer	Získá čas trénování pro iteraci.
trainingType	TrainingType	Získá typ trénování iterace.

TrainingParameters

Parametry používané pro trénování

Name	Typ	Description
selectedTags	string[]	Seznam značek vybraných pro tuto trénovací relaci, ostatní značky v projektu budou ignorovány.

TrainingType

Získá typ trénování iterace.

Name	Typ	Description
Advanced	string
Regular	string