MpiDistribution Class

MPI distribution configuration.

Inheritance

azure.ai.ml.entities._job.distribution.DistributionConfiguration

MpiDistribution

Constructor

MpiDistribution(*, process_count_per_instance: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
process_count_per_instance	Optional[int] The number of processes per node.

Examples

Configuring a CommandComponent with an MpiDistribution.

   from azure.ai.ml import MpiDistribution
   from azure.ai.ml.entities import CommandComponent

   component = CommandComponent(
       name="microsoftsamples_mpi",
       description="This is the MPI command component",
       inputs={
           "component_in_number": {"description": "A number", "type": "number", "default": 10.99},
           "component_in_path": {"description": "A path", "type": "uri_folder"},
       },
       outputs={"component_out_path": {"type": "uri_folder"}},
       command="echo Hello World & echo ${{inputs.component_in_number}} & echo ${{inputs.component_in_path}} "
       "& echo ${{outputs.component_out_path}}",
       environment="AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33",
       distribution=MpiDistribution(
           process_count_per_instance=2,
       ),
       instance_count=2,
   )

Variables

Name	Description
type	str Specifies the type of distribution. Set automatically to "mpi" for this class.