BatchDeploymentProperties interface

  • Reference
Package:
@azure/arm-machinelearning

Batch inference settings per deployment.

Extends
EndpointDeploymentPropertiesBase

Properties

compute

Compute target for batch inference operation.
deploymentConfiguration

Properties relevant to different deployment types.
errorThreshold

Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored.
loggingLevel

Logging level for batch inference operation.
maxConcurrencyPerInstance

Indicates maximum number of parallelism per instance.
miniBatchSize

Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch.
model

Reference to the model asset for the endpoint deployment.
outputAction

Indicates how the output will be organized.
outputFileName

Customized output file name for append_row output action.
provisioningState

Provisioning state for the endpoint deployment. NOTE: This property will not be serialized. It can only be populated by the server.
resources

Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.
retrySettings

Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.

Inherited Properties

codeConfiguration

Code configuration for the endpoint deployment.
description

Description of the endpoint deployment.
environmentId

ARM resource ID or AssetId of the environment specification for the endpoint deployment.
environmentVariables

Environment variables configuration for the deployment.
properties

Property dictionary. Properties can be added, but not removed or altered.

Property Details

compute

Compute target for batch inference operation.

compute?: string

Property Value

string

deploymentConfiguration

Properties relevant to different deployment types.

deploymentConfiguration?: BatchDeploymentConfigurationUnion

Property Value

BatchDeploymentConfigurationUnion

errorThreshold

Error threshold, if the error count for the entire input goes above this value, the batch inference will be aborted. Range is [-1, int.MaxValue]. For FileDataset, this value is the count of file failures. For TabularDataset, this value is the count of record failures. If set to -1 (the lower bound), all failures during batch inference will be ignored.

errorThreshold?: number

Property Value

number

loggingLevel

Logging level for batch inference operation.

loggingLevel?: string

Property Value

string

maxConcurrencyPerInstance

Indicates maximum number of parallelism per instance.

maxConcurrencyPerInstance?: number

Property Value

number

miniBatchSize

Size of the mini-batch passed to each batch invocation. For FileDataset, this is the number of files per mini-batch. For TabularDataset, this is the size of the records in bytes, per mini-batch.

miniBatchSize?: number

Property Value

number

model

Reference to the model asset for the endpoint deployment.

model?: AssetReferenceBaseUnion

Property Value

AssetReferenceBaseUnion

outputAction

Indicates how the output will be organized.

outputAction?: string

Property Value

string

outputFileName

Customized output file name for append_row output action.

outputFileName?: string

Property Value

string

provisioningState

Provisioning state for the endpoint deployment. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resources

Indicates compute configuration for the job. If not provided, will default to the defaults defined in ResourceConfiguration.

resources?: DeploymentResourceConfiguration

Property Value

DeploymentResourceConfiguration

retrySettings

Retry Settings for the batch inference operation. If not provided, will default to the defaults defined in BatchRetrySettings.

retrySettings?: BatchRetrySettings

Property Value

BatchRetrySettings

Inherited Property Details

codeConfiguration

Code configuration for the endpoint deployment.

codeConfiguration?: CodeConfiguration

Property Value

CodeConfiguration

Inherited From EndpointDeploymentPropertiesBase.codeConfiguration

description

Description of the endpoint deployment.

description?: string

Property Value

string

Inherited From EndpointDeploymentPropertiesBase.description

environmentId

ARM resource ID or AssetId of the environment specification for the endpoint deployment.

environmentId?: string

Property Value

string

Inherited From EndpointDeploymentPropertiesBase.environmentId

environmentVariables

Environment variables configuration for the deployment.

environmentVariables?: {[propertyName: string]: string | null}

Property Value

{[propertyName: string]: string | null}

Inherited From EndpointDeploymentPropertiesBase.environmentVariables

properties

Property dictionary. Properties can be added, but not removed or altered.

properties?: {[propertyName: string]: string | null}

Property Value

{[propertyName: string]: string | null}

Inherited From EndpointDeploymentPropertiesBase.properties