Skip to content

DistributedNodeConfig

kedro_azureml_pipeline.distributed.DistributedNodeConfig dataclass

Configuration for a distributed training node.

Parameters

Name Type Description Default
framework Framework

Distributed training framework to use.

 required
num_nodes str or int

Number of compute nodes.

 required
processes_per_node str, int, or None

Number of processes to launch per node.

 None

See Also

distributed_job : Decorator that creates this config. AzureMLPipelineGenerator : Reads this config during generation.

Source Code

View on GitHub

Show/Hide source 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
@dataclass
class DistributedNodeConfig:
    """Configuration for a distributed training node.

    Parameters
    ----------
    framework : Framework
        Distributed training framework to use.
    num_nodes : str or int
        Number of compute nodes.
    processes_per_node : str, int, or None
        Number of processes to launch per node.

    See Also
    --------
    [distributed_job][kedro_azureml_pipeline.distributed.decorators.distributed_job] : Decorator that creates this config.
    [AzureMLPipelineGenerator][kedro_azureml_pipeline.generator.AzureMLPipelineGenerator] : Reads this config during generation.
    """

    framework: Framework
    num_nodes: str | int
    processes_per_node: str | int | None = None

    def __repr__(self):
        """Return a JSON string representation.

        Returns
        -------
        str
            JSON-serialized configuration.
        """
        return json.dumps(asdict(self))

    def __str__(self):
        """Return a JSON string representation.

        Returns
        -------
        str
            JSON-serialized configuration.
        """
        return self.__repr__()

Methods

__repr__()

Return a JSON string representation.

Returns
Type Description
str

JSON-serialized configuration.
Source Code

View on GitHub

Show/Hide source 
39
40
41
42
43
44
45
46
47
def __repr__(self):
    """Return a JSON string representation.

    Returns
    -------
    str
        JSON-serialized configuration.
    """
    return json.dumps(asdict(self))

__str__()

Return a JSON string representation.

Returns
Type Description
str

JSON-serialized configuration.
Source Code

View on GitHub

Show/Hide source 
49
50
51
52
53
54
55
56
57
def __str__(self):
    """Return a JSON string representation.

    Returns
    -------
    str
        JSON-serialized configuration.
    """
    return self.__repr__()