BatchDeployment Class

Batch endpoint deployment entity.

Inheritance

azure.ai.ml.entities._deployment.deployment.Deployment

BatchDeployment

Constructor

BatchDeployment(*, name: str, endpoint_name: str | None = None, description: str | None = None, tags: Dict[str, Any] | None = None, properties: Dict[str, str] | None = None, model: str | Model | None = None, code_configuration: CodeConfiguration | None = None, environment: str | Environment | None = None, compute: str | None = None, resources: ResourceConfiguration | None = None, output_file_name: str | None = None, output_action: BatchDeploymentOutputAction | str | None = None, error_threshold: int | None = None, retry_settings: BatchRetrySettings | None = None, logging_level: str | None = None, mini_batch_size: int | None = None, max_concurrency_per_instance: int | None = None, environment_variables: Dict[str, str] | None = None, code_path: PathLike | str | None = None, scoring_script: PathLike | str | None = None, instance_count: int | None = None, **kwargs: Any)

Parameters

Name	Description
name Required	str the name of the batch deployment
description Required	str Description of the resource.
tags Required	dict[str, str] Tag dictionary. Tags can be added, removed, and updated.
properties Required	dict[str, str] The asset property dictionary.
model Required	Union[str, Model] Model entity for the endpoint deployment, defaults to None
code_configuration Required	CodeConfiguration defaults to None
environment Required	Union[str, Environment] Environment entity for the endpoint deployment., defaults to None
compute Required	str Compute target for batch inference operation.
output_action Required	str or BatchDeploymentOutputAction Indicates how the output will be organized. Possible values include: "summary_only", "append_row". Defaults to "append_row"
output_file_name Required	str Customized output file name for append_row output action, defaults to "predictions.csv"
max_concurrency_per_instance Required	int Indicates maximum number of parallelism per instance, defaults to 1
error_threshold Required	int 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] -1 value indicates, ignore all failures during batch inference For FileDataset count of file failures For TabularDataset, this is the count of record failures, defaults to -1
retry_settings Required	BatchRetrySettings Retry settings for a batch inference operation, defaults to None
resources Required	ResourceConfiguration Indicates compute configuration for the job.
logging_level Required	str Logging level for batch inference operation, defaults to "info"
mini_batch_size Required	int Size of the mini-batch passed to each batch invocation, defaults to 10
environment_variables Required	dict Environment variables that will be set in deployment.
code_path Required	Union[str, <xref:PathLike>] Folder path to local code assets. Equivalent to code_configuration.code.
scoring_script Required	Union[str, <xref:PathLike>] Scoring script name. Equivalent to code_configuration.code.scoring_script.
instance_count Required	int Number of instances the interfering will run on. Equivalent to resources.instance_count.

Keyword-Only Parameters

Name	Description
name Required
endpoint_name Required
description Required
tags Required
properties Required
model Required
code_configuration Required
environment Required
compute Required
resources Required
output_file_name Required
output_action Required
error_threshold Required
retry_settings Required
logging_level Required
mini_batch_size Required
max_concurrency_per_instance Required
environment_variables Required
code_path Required
scoring_script Required
instance_count Required

Methods

dump	Dump the deployment content into a file in yaml format.

dump

Dump the deployment content into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name	Description
dest Required	Union[PathLike, str, IO[AnyStr]] The destination to receive this deployment's content. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type	Description
str	The base path of the resource.

code_path

The code directory containing the scoring script.

Returns

Type	Description
Union[str, <xref:PathLike>]

creation_context

The creation context of the resource.

Returns

Type	Description
Optional[SystemData]	The creation metadata for the resource.

id

The resource ID.

Returns

Type	Description
Optional[str]	The global ID of the resource, an Azure Resource Manager (ARM) ID.

instance_count

provisioning_state

Batch deployment provisioning state, readonly.

Returns

Type	Description
Optional[str]	Batch deployment provisioning state.

scoring_script

The scoring script file path relative to the code directory.

Returns

Type	Description
Union[str, <xref:PathLike>]

type

Type of deployment.

Returns

Type	Description
str