TrainingAPIClientTrainProjectOptionalParams interface

Package:

@azure/cognitiveservices-customvision-training

Optional Parameters.

Extends

RequestOptionsBase

Properties

forceTrain	Whether to force train even if dataset and configuration does not change (default: false). Default value: false.
notificationEmailAddress	The email address to send notification to when training finishes (default: null).
reservedBudgetInHours	The number of hours reserved as budget for training (if applicable). Default value: 0.
trainingParameters	Additional training parameters passed in to control how the project is trained.
trainingType	The type of training to use to train the project (default: Regular). Possible values include: 'Regular', 'Advanced'

Inherited Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

forceTrain

Whether to force train even if dataset and configuration does not change (default: false). Default value: false.

forceTrain?: boolean

Property Value

boolean

notificationEmailAddress

The email address to send notification to when training finishes (default: null).

notificationEmailAddress?: string

Property Value

string

reservedBudgetInHours

The number of hours reserved as budget for training (if applicable). Default value: 0.

reservedBudgetInHours?: number

Property Value

number

trainingParameters

Additional training parameters passed in to control how the project is trained.

trainingParameters?: TrainingParameters

Property Value

TrainingParameters

trainingType

The type of training to use to train the project (default: Regular). Possible values include: 'Regular', 'Advanced'

trainingType?: TrainingType1

Property Value

TrainingType1

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout