ParallelJob Class

Parallel job.

Inheritance

azure.ai.ml.entities._job.job.Job

ParallelJob

azure.ai.ml.entities._job.parallel.parameterized_parallel.ParameterizedParallel

ParallelJob

azure.ai.ml.entities._job.job_io_mixin.JobIOMixin

ParallelJob

Constructor

ParallelJob(*, inputs: Dict[str, Input | str | bool | int | float] | None = None, outputs: Dict[str, Output] | None = None, identity: Dict | ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, **kwargs: Any)

Parameters

Name	Description
name Required	str Name of the job.
version Required	str Version of the job.
id Required	str Global id of the resource, Azure Resource Manager ID.
type Required	str Type of the job, supported is 'parallel'.
description Required	str Description of the job.
tags Required	dict Internal use only.
properties Required	dict Internal use only.
display_name Required	str Display name of the job.
retry_settings Required	BatchRetrySettings parallel job run failed retry
logging_level Required	str A string of the logging level name
max_concurrency_per_instance Required	int The max parallellism that each compute instance has.
error_threshold Required	int The number of item processing failures should be ignored.
mini_batch_error_threshold Required	int The number of mini batch processing failures should be ignored.
task Required	ParallelTask The parallel task.
mini_batch_size Required	str The mini batch size.
partition_keys Required	list The partition keys.
input_data Required	str The input data.
inputs Required	dict Inputs of the job.
outputs Required	dict Outputs of the job.

Keyword-Only Parameters

Name	Description
identity	Optional[Union[<xref:azure.ai.ml.ManagedIdentityConfiguration>, <xref:azure.ai.ml.AmlTokenConfiguration>, <xref:azure.ai.ml.UserIdentityConfiguration>]] The identity that the job will use while running on compute.
inputs Required
outputs Required

Methods

dump	Dumps the job content into a file in YAML format.

dump

Dumps the job content into a file in YAML format.

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

Parameters

Name	Description
dest Required	Union[<xref:PathLike>, str, IO[AnyStr]] The local path or file stream to write the YAML content to. If dest is a file path, a new file will be created. If dest is an open file, the file will be written to directly.

Exceptions

Type	Description
FileExistsError	Raised if dest is a file path and the file already exists.
IOError	Raised if dest is an open file and the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type	Description
str	The base path of the resource.

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.

inputs

log_files

Job output files.

Returns

Type	Description
Optional[Dict[str, str]]	The dictionary of log names and URLs.

outputs

resources

retry_settings

status

The status of the job.

Common values returned include "Running", "Completed", and "Failed". All possible values are:

• NotStarted - This is a temporary state that client-side Run objects are in before cloud submission.

• Starting - The Run has started being processed in the cloud. The caller has a run ID at this point.

• Provisioning - On-demand compute is being created for a given job submission.

• Preparing - The run environment is being prepared and is in one of two stages:

  • Docker image build

  • conda environment setup

• Queued - The job is queued on the compute target. For example, in BatchAI, the job is in a queued state

  while waiting for all the requested nodes to be ready.

• Running - The job has started to run on the compute target.

• Finalizing - User code execution has completed, and the run is in post-processing stages.

• CancelRequested - Cancellation has been requested for the job.

• Completed - The run has completed successfully. This includes both the user code execution and run

  post-processing stages.

• Failed - The run failed. Usually the Error property on a run will provide details as to why.

• Canceled - Follows a cancellation request and indicates that the run is now successfully cancelled.

• NotResponding - For runs that have Heartbeats enabled, no heartbeat has been recently sent.

Returns

Type	Description
Optional[str]	Status of the job.

studio_url

Azure ML studio endpoint.

Returns

Type	Description
Optional[str]	The URL to the job details page.

task

type

The type of the job.

Returns

Type	Description
Optional[str]	The type of the job.