Source code for lightning.fabric.plugins.environments.cluster_environment

# Copyright The Lightning AI team.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
from abc import ABC, abstractmethod

[docs]class ClusterEnvironment(ABC): """Specification of a cluster environment.""" @property @abstractmethod def creates_processes_externally(self) -> bool: """Whether the environment creates the subprocesses or not.""" @property @abstractmethod def main_address(self) -> str: """The main address through which all processes connect and communicate.""" @property @abstractmethod def main_port(self) -> int: """An open and configured port in the main node through which all processes communicate."""
[docs] @staticmethod @abstractmethod def detect() -> bool: """Detects the environment settings corresponding to this cluster and returns ``True`` if they match."""
[docs] @abstractmethod def world_size(self) -> int: """The number of processes across all devices and nodes."""
@abstractmethod def set_world_size(self, size: int) -> None: pass
[docs] @abstractmethod def global_rank(self) -> int: """The rank (index) of the currently running process across all nodes and devices."""
@abstractmethod def set_global_rank(self, rank: int) -> None: pass
[docs] @abstractmethod def local_rank(self) -> int: """The rank (index) of the currently running process inside of the current node."""
[docs] @abstractmethod def node_rank(self) -> int: """The rank (index) of the node on which the current process runs."""
[docs] def validate_settings(self, num_devices: int, num_nodes: int) -> None: """Validates settings configured in the script against the environment, and raises an exception if there is an inconsistency.""" pass
[docs] def teardown(self) -> None: """Clean up any state set after execution finishes.""" pass