Iteration interface

Package:

@azure/cognitiveservices-customvision-training

Iteration model to be sent over JSON.

Properties

classificationType	Gets the classification type of the project. Possible values include: 'Multiclass', 'Multilabel' NOTE: This property will not be serialized. It can only be populated by the server.
created	Gets the time this iteration was completed. NOTE: This property will not be serialized. It can only be populated by the server.
customBaseModelInfo	Information of the previously trained iteration which provides the base model for current iteration's training. Default value of null specifies that no previously trained iteration will be used for incremental learning. NOTE: This property will not be serialized. It can only be populated by the server.
domainId	Get or sets a guid of the domain the iteration has been trained on. NOTE: This property will not be serialized. It can only be populated by the server.
exportable	Whether the iteration can be exported to another format for download. NOTE: This property will not be serialized. It can only be populated by the server.
exportableTo	A set of platforms this iteration can export to. NOTE: This property will not be serialized. It can only be populated by the server.
id	Gets the id of the iteration. NOTE: This property will not be serialized. It can only be populated by the server.
lastModified	Gets the time this iteration was last modified. NOTE: This property will not be serialized. It can only be populated by the server.
name	Gets or sets the name of the iteration.
originalPublishResourceId	Resource Provider Id this iteration was originally published to. NOTE: This property will not be serialized. It can only be populated by the server.
projectId	Gets the project id of the iteration. NOTE: This property will not be serialized. It can only be populated by the server.
publishName	Name of the published model. NOTE: This property will not be serialized. It can only be populated by the server.
reservedBudgetInHours	Gets the reserved advanced training budget for the iteration. NOTE: This property will not be serialized. It can only be populated by the server.
status	Gets the current iteration status. NOTE: This property will not be serialized. It can only be populated by the server.
trainedAt	Gets the time this iteration was last modified. NOTE: This property will not be serialized. It can only be populated by the server.
trainingErrorDetails	Training error details, when training fails. Value is null when training succeeds. NOTE: This property will not be serialized. It can only be populated by the server.
trainingTimeInMinutes	Gets the training time for the iteration. NOTE: This property will not be serialized. It can only be populated by the server.
trainingType	Gets the training type of the iteration. Possible values include: 'Regular', 'Advanced' NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

classificationType

Gets the classification type of the project. Possible values include: 'Multiclass', 'Multilabel' NOTE: This property will not be serialized. It can only be populated by the server.

classificationType?: Classifier

Property Value

Classifier

created

Gets the time this iteration was completed. NOTE: This property will not be serialized. It can only be populated by the server.

created?: Date

Property Value

Date

customBaseModelInfo

Information of the previously trained iteration which provides the base model for current iteration's training. Default value of null specifies that no previously trained iteration will be used for incremental learning. NOTE: This property will not be serialized. It can only be populated by the server.

customBaseModelInfo?: CustomBaseModelInfo

Property Value

CustomBaseModelInfo

domainId

Get or sets a guid of the domain the iteration has been trained on. NOTE: This property will not be serialized. It can only be populated by the server.

domainId?: string

Property Value

string

exportable

Whether the iteration can be exported to another format for download. NOTE: This property will not be serialized. It can only be populated by the server.

exportable?: boolean

Property Value

boolean

exportableTo

A set of platforms this iteration can export to. NOTE: This property will not be serialized. It can only be populated by the server.

exportableTo?: string[]

Property Value

string[]

id

Gets the id of the iteration. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

lastModified

Gets the time this iteration was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

lastModified?: Date

Property Value

Date

name

Gets or sets the name of the iteration.

name: string

Property Value

string

originalPublishResourceId

Resource Provider Id this iteration was originally published to. NOTE: This property will not be serialized. It can only be populated by the server.

originalPublishResourceId?: string

Property Value

string

projectId

Gets the project id of the iteration. NOTE: This property will not be serialized. It can only be populated by the server.

projectId?: string

Property Value

string

publishName

Name of the published model. NOTE: This property will not be serialized. It can only be populated by the server.

publishName?: string

Property Value

string

reservedBudgetInHours

Gets the reserved advanced training budget for the iteration. NOTE: This property will not be serialized. It can only be populated by the server.

reservedBudgetInHours?: number

Property Value

number

status

Gets the current iteration status. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

trainedAt

Gets the time this iteration was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

trainedAt?: Date

Property Value

Date

trainingErrorDetails

Training error details, when training fails. Value is null when training succeeds. NOTE: This property will not be serialized. It can only be populated by the server.

trainingErrorDetails?: string

Property Value

string

trainingTimeInMinutes

Gets the training time for the iteration. NOTE: This property will not be serialized. It can only be populated by the server.

trainingTimeInMinutes?: number

Property Value

number

trainingType

Gets the training type of the iteration. Possible values include: 'Regular', 'Advanced' NOTE: This property will not be serialized. It can only be populated by the server.

trainingType?: TrainingType

Property Value

TrainingType