Projects - Train

Служба:

Cognitive Services - Custom Vision

Версия API:

3.3

Ставит проект в очередь для обучения.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services.
projectId	path	True	string uuid	Идентификатор проекта.
forceTrain	query		boolean	Следует ли принудительно обучить, даже если набор данных и конфигурация не изменяются (по умолчанию: false).
notificationEmailAddress	query		string	Адрес электронной почты, на который отправляется уведомление о завершении обучения (по умолчанию: null).
reservedBudgetInHours	query		integer int32	Количество часов, зарезервированных в качестве бюджета для обучения (если применимо).
trainingType	query		string	Тип обучения, используемый для обучения проекта (по умолчанию: Обычный).

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
Training-Key	True	string

Текст запроса

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

Имя	Тип	Описание
selectedTags	string[]	Список тегов, выбранных для этого сеанса обучения, другие теги в проекте будут игнорироваться.

Ответы

Имя	Тип	Описание
200 OK	Iteration	ОК Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Сообщение об ошибке Media Types: "application/json", "application/xml", "text/xml"

Безопасность

Training-Key

Тип: apiKey
В: header

Примеры

Successful TrainProject request

Образец запроса

HTTP

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


{}

Пример ответа

Код состояния:

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

Определения

Имя	Описание
Classifier	Возвращает тип классификации проекта.
CustomVisionError
CustomVisionErrorCodes	Код ошибки.
ExportableTo	Набор платформ, на которые может экспортироваться эта итерация.
Iteration	Модель итерации, отправляемая по json.
TrainingParameters	Параметры, используемые для обучения.
TrainingType	Возвращает тип обучения итерации.

Classifier

Возвращает тип классификации проекта.

Имя	Тип	Описание
Multiclass	string
Multilabel	string

CustomVisionError

Имя	Тип	Описание
code	CustomVisionErrorCodes	Код ошибки.
message	string	Сообщение с объяснением ошибки, о которую сообщила служба.

CustomVisionErrorCodes

Код ошибки.

Имя	Тип	Описание
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

Набор платформ, на которые может экспортироваться эта итерация.

Имя	Тип	Описание
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string

Iteration

Модель итерации, отправляемая по json.

Имя	Тип	Описание
classificationType	Classifier	Возвращает тип классификации проекта.
created	string	Возвращает время завершения этой итерации.
domainId	string	Возвращает или задает guid домена, для которого была обучена итерация.
exportable	boolean	Можно ли экспортировать итерацию в другой формат для скачивания.
exportableTo	ExportableTo[]	Набор платформ, на которые может экспортироваться эта итерация.
id	string	Возвращает идентификатор итерации.
lastModified	string	Возвращает время последнего изменения этой итерации.
name	string	Возвращает или задает имя итерации.
originalPublishResourceId	string	Идентификатор поставщика ресурсов, в котором эта итерация была первоначально опубликована.
projectId	string	Возвращает идентификатор проекта итерации.
publishName	string	Имя опубликованной модели.
reservedBudgetInHours	integer	Возвращает зарезервированный бюджет расширенного обучения для итерации.
status	string	Возвращает текущее состояние итерации.
trainedAt	string	Возвращает время последнего изменения этой итерации.
trainingTimeInMinutes	integer	Возвращает время обучения для итерации.
trainingType	TrainingType	Возвращает тип обучения итерации.

TrainingParameters

Параметры, используемые для обучения.

Имя	Тип	Описание
selectedTags	string[]	Список тегов, выбранных для этого сеанса обучения, другие теги в проекте будут игнорироваться.

TrainingType

Возвращает тип обучения итерации.

Имя	Тип	Описание
Advanced	string
Regular	string