Iterations - Get Performance

Service:: Azure AI Services

API Version:: 3.3

Get detailed performance information about an iteration.

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

With optional parameters:

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}&overlapThreshold={overlapThreshold}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints.
iterationId	path	True	string (uuid)	The id of the iteration to get.
projectId	path	True	string (uuid)	The id of the project the iteration belongs to.
overlapThreshold	query		number (float)	If applicable, the bounding box overlap threshold used to determine true predictions.
threshold	query		number (float)	The threshold used to determine true predictions.

Request Header

Name	Required	Type	Description
Training-Key	True	string

Responses

Name	Type	Description
200 OK	IterationPerformance	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Error response Media Types: "application/json", "application/xml", "text/xml"

Name

Type

Description

200 OK

IterationPerformance

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 GetIterationPerformance request

Sample request

HTTP

GET https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/iterations/fe1e83c4-6f50-4899-9544-6bb08cf0e15a/performance?threshold=0.9

Sample response

Status code:: 200

{
  "perTagPerformance": [
    {
      "id": "e31ff107-5505-4753-be42-b369b21b026c",
      "name": "Hemlock",
      "precision": 1,
      "precisionStdDeviation": 0,
      "recall": 1,
      "recallStdDeviation": 0
    },
    {
      "id": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
      "name": "Japanese Cherry",
      "precision": 1,
      "precisionStdDeviation": 0,
      "recall": 1,
      "recallStdDeviation": 0
    }
  ],
  "precision": 1,
  "precisionStdDeviation": 0,
  "recall": 1,
  "recallStdDeviation": 0
}

Definitions

Name	Description
CustomVisionError
CustomVisionErrorCodes	The error code.
IterationPerformance	Represents the detailed performance data for a trained iteration.
TagPerformance	Represents performance data for a particular tag in a trained iteration.

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

IterationPerformance

Object

Represents the detailed performance data for a trained iteration.

Name	Type	Description
averagePrecision	number (float)	Gets the average precision when applicable.
perTagPerformance	TagPerformance[]	Gets the per-tag performance details for this iteration.
precision	number (float)	Gets the precision.
precisionStdDeviation	number (float)	Gets the standard deviation for the precision.
recall	number (float)	Gets the recall.
recallStdDeviation	number (float)	Gets the standard deviation for the recall.

TagPerformance

Object

Represents performance data for a particular tag in a trained iteration.

Name	Type	Description
averagePrecision	number (float)	Gets the average precision when applicable.
id	string (uuid)
name	string
precision	number (float)	Gets the precision.
precisionStdDeviation	number (float)	Gets the standard deviation for the precision.
recall	number (float)	Gets the recall.
recallStdDeviation	number (float)	Gets the standard deviation for the recall.

Share via

Iterations - Get Performance

URI Parameters

Request Header

Responses

Security

Training-Key

Examples

Successful GetIterationPerformance request

Sample request

Sample response

Definitions

CustomVisionError

CustomVisionErrorCodes

IterationPerformance

TagPerformance