Share via

ModelBatchDeployment Class

  • Reference

Model Batch Deployment entity.

Constructor

ModelBatchDeployment(*, name: str, endpoint_name: str | None = None, environment: str | Environment | None = None, properties: Dict[str, str] | None = None, model: str | Model | None = None, description: str | None = None, tags: Dict[str, Any] | None = None, settings: ModelBatchDeploymentSettings | None = None, resources: ResourceConfiguration | None = None, compute: str | None = None, code_configuration: CodeConfiguration | None = None, code_path: str | PathLike | None = None, scoring_script: str | PathLike | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the deployment resource.
endpoint_name
Required
Optional[str]

Name of the endpoint.
environment
Required
Optional[Union[str, Environment]]

Environment to use for deployment.
properties
Required
Optional[Dict[str, str]]

The asset property dictionary.
model
Required
Optional[Union[str, Model]]

Model to deploy.
description
Required
Optional[str]

Deployment description.
tags
Required
Optional[Dict[str, Any]]

Deployment tags.
settings
Required
Optional[ModelBatchDeploymentSettings]

Deployment settings.
resources
Required
Optional[ResourceConfiguration]

Resource configuration.
compute
Required
Optional[str]

Compute target to use.
code_configuration
Required
Optional[CodeConfiguration]

Code configuration for deployment.
code_path
Required
Optional[Union[str, <xref:PathLike>]]

Path to the code directory.
scoring_script
Required
Optional[Union[str, <xref:PathLike>]]

Path to the scoring script.

Keyword-Only Parameters

Name Description
name
Required
endpoint_name
Default value: None
environment
Default value: None
properties
Default value: None
model
Default value: None
description
Default value: None
tags
Default value: None
settings
Default value: None
resources
Default value: None
compute
Default value: None
code_configuration
Default value: None
code_path
Default value: None
scoring_script
Default value: None

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>]

settings

type

Type of deployment.

Returns

Type Description
str