Share via

Iterations - Update

Service:
Azure AI Services
API Version:
3.3

Update a specific iteration.

PATCH {Endpoint}/customvision/v3.3/training/projects/{projectId}/iterations/{iterationId}

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoints.
iterationId
 path True

string (uuid)

Iteration id.
projectId
 path True

string (uuid)

Project id.

Request Header

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

Name Required Type Description
Training-Key True

string

Request Body

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

Name Required Type Description
name True

string

Gets or sets the name of the iteration.

Responses

Name Type Description
200 OK

Iteration

OK

Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes

CustomVisionError

Error response

Media Types: "application/json", "application/xml", "text/xml"

Security

Training-Key

Type: apiKey
In: header

Examples

Successful UpdateIteration request

Sample request

PATCH https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/iterations/e31a14ab-5d78-4f7b-a267-3a1e4fd8a758


{
  "name": "Best Iteration"
}

Sample response

Status code:
200 
{
  "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758",
  "name": "Best Iteration",
  "status": "Completed",
  "created": "2017-12-18T22:40:36Z",
  "lastModified": "2017-12-19T15:53:07Z",
  "trainedAt": "2017-12-19T15:47:02Z",
  "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c",
  "exportable": false,
  "exportableTo": [
    "ONNX",
    "DockerFile",
    "TensorFlow",
    "CoreML"
  ],
  "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31",
  "trainingType": "Regular",
  "reservedBudgetInHours": 0,
  "publishName": ""
}

Definitions

Name Description
Classifier

Gets the classification type of the project.
CustomVisionError
CustomVisionErrorCodes

The error code.
ExportableTo

A set of platforms this iteration can export to.
Iteration

Iteration model to be sent over JSON.
TrainingType

Gets the training type of the iteration.

Classifier

Enumeration

Gets the classification type of the project.

Value Description
Multiclass
Multilabel

CustomVisionError

Object
Name Type Description
code

CustomVisionErrorCodes

The error code.
message

string

A message explaining the error reported by the service.

CustomVisionErrorCodes

Enumeration

The error code.

Value 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
BadRequestImageExceededCount
BadRequestTrainingNotNeeded
BadRequestTrainingNotNeededButTrainingPipelineUpdated
BadRequestTrainingValidationFailed
BadRequestClassificationTrainingValidationFailed
BadRequestMultiClassClassificationTrainingValidationFailed
BadRequestMultiLabelClassificationTrainingValidationFailed
BadRequestDetectionTrainingValidationFailed
BadRequestTrainingAlreadyInProgress
BadRequestDetectionTrainingNotAllowNegativeTag
BadRequestInvalidEmailAddress
BadRequestDomainNotSupportedForAdvancedTraining
BadRequestExportPlatformNotSupportedForAdvancedTraining
BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining
BadRequestExportValidationFailed
BadRequestExportAlreadyInProgress
BadRequestPredictionIdsMissing
BadRequestPredictionIdsExceededCount
BadRequestPredictionTagsExceededCount
BadRequestPredictionResultsExceededCount
BadRequestPredictionInvalidApplicationName
BadRequestPredictionInvalidQueryParameters
BadRequestInvalidImportToken
BadRequestExportWhileTraining
BadRequestImageMetadataKey
BadRequestImageMetadataValue
BadRequestOperationNotSupported
BadRequestInvalidArtifactUri
BadRequestCustomerManagedKeyRevoked
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
ErrorInvalid

ExportableTo

Enumeration

A set of platforms this iteration can export to.

Value Description
CoreML
TensorFlow
DockerFile
ONNX
VAIDK

Iteration

Object

Iteration model to be sent over JSON.

Name Type Description
classificationType

Classifier

Gets the classification type of the project.
created

string (date-time)

Gets the time this iteration was completed.
domainId

string (uuid)

Get or sets a guid of the domain the iteration has been trained on.
exportable

boolean

Whether the iteration can be exported to another format for download.
exportableTo

ExportableTo[]

A set of platforms this iteration can export to.
id

string (uuid)

Gets the id of the iteration.
lastModified

string (date-time)

Gets the time this iteration was last modified.
name

string

Gets or sets the name of the iteration.
originalPublishResourceId

string

Resource Provider Id this iteration was originally published to.
projectId

string (uuid)

Gets the project id of the iteration.
publishName

string

Name of the published model.
reservedBudgetInHours

integer (int32)

Gets the reserved advanced training budget for the iteration.
status

string

Gets the current iteration status.
trainedAt

string (date-time)

Gets the time this iteration was last modified.
trainingTimeInMinutes

integer (int32)

Gets the training time for the iteration.
trainingType

TrainingType

Gets the training type of the iteration.

TrainingType

Enumeration

Gets the training type of the iteration.

Value Description
Regular
Advanced