ParameterizedCommand Class

Command component version that contains the command and supporting parameters for a Command component or job.

This class should not be instantiated directly. Instead, use the child class ~azure.ai.ml.entities.CommandComponent.

Inheritance
builtins.object
ParameterizedCommand

Constructor

ParameterizedCommand(command: str | None = '', resources: dict | JobResourceConfiguration | None = None, code: PathLike | str | None = None, environment_variables: Dict | None = None, distribution: Dict | MpiDistribution | TensorFlowDistribution | PyTorchDistribution | RayDistribution | DistributionConfiguration | None = None, environment: Environment | str | None = None, queue_settings: QueueSettings | None = None, **kwargs: Dict)

Parameters

Name Description
command
Required
str

The command to be executed. Defaults to "".

resources

The compute resource configuration for the command.

Default value: None
code

The source code to run the job. Can be a local path or "http:", "https:", or "azureml:" url pointing to a remote location.

Default value: None
environment_variables

A dictionary of environment variable names and values. These environment variables are set on the process where user script is being executed.

Default value: None
distribution

The distribution configuration for distributed jobs.

Default value: None
environment

The environment that the job will run in.

Default value: None
queue_settings

The queue settings for the job.

Default value: None

Keyword-Only Parameters

Name Description
kwargs

A dictionary of additional configuration parameters.

Attributes

distribution

The configuration for the distributed command component or job.

Returns

Type Description

The distribution configuration.

resources

The compute resource configuration for the command component or job.

Returns

Type Description

The compute resource configuration for the command component or job.