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	Optional[Union[dict, JobResourceConfiguration]] The compute resource configuration for the command. default value: None
code	Optional[str] 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	Optional[dict[str, str]] 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	Optional[Union[dict, PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] The distribution configuration for distributed jobs. default value: None
environment	Optional[Union[str, Environment]] The environment that the job will run in. default value: None
queue_settings	Optional[QueueSettings] The queue settings for the job. default value: None

Keyword-Only Parameters

Name	Description
kwargs	dict A dictionary of additional configuration parameters.

Attributes

distribution

The configuration for the distributed command component or job.

Returns

Type	Description
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	The distribution configuration.

resources

The compute resource configuration for the command component or job.

Returns

Type	Description
JobResourceConfiguration	The compute resource configuration for the command component or job.