Source code for pytorch_lightning.strategies.parallel
# Copyright The PyTorch Lightning 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from abc import ABC, abstractmethod
from contextlib import contextmanager
from typing import Any, List, Optional
import torch
from torch.nn.parallel import DistributedDataParallel
import pytorch_lightning as pl
from pytorch_lightning.overrides.base import unwrap_lightning_module
from pytorch_lightning.plugins import LayerSync
from pytorch_lightning.plugins.environments.cluster_environment import ClusterEnvironment
from pytorch_lightning.plugins.io.checkpoint_plugin import CheckpointIO
from pytorch_lightning.plugins.precision import PrecisionPlugin
from pytorch_lightning.strategies.strategy import Strategy
from pytorch_lightning.utilities.distributed import (
_get_process_group_backend_from_env,
all_gather_ddp_if_available,
get_default_process_group_backend_for_device,
ReduceOp,
)
from pytorch_lightning.utilities.warnings import rank_zero_deprecation
[docs]class ParallelStrategy(Strategy, ABC):
"""Plugin for training with multiple processes in parallel."""
def __init__(
self,
accelerator: Optional["pl.accelerators.accelerator.Accelerator"] = None,
parallel_devices: Optional[List[torch.device]] = None,
cluster_environment: Optional[ClusterEnvironment] = None,
checkpoint_io: Optional[CheckpointIO] = None,
precision_plugin: Optional[PrecisionPlugin] = None,
):
super().__init__(accelerator=accelerator, checkpoint_io=checkpoint_io, precision_plugin=precision_plugin)
self.parallel_devices = parallel_devices
self.cluster_environment = cluster_environment
self._layer_sync: Optional[LayerSync] = None
@property
@abstractmethod
def root_device(self) -> torch.device:
"""Return the root device."""
@property
def lightning_module(self) -> Optional["pl.LightningModule"]:
return unwrap_lightning_module(self.model) if self.model is not None else None
@property
def global_rank(self) -> int:
return self.cluster_environment.global_rank() if self.cluster_environment is not None else 0
@property
def local_rank(self) -> int:
return self.cluster_environment.local_rank() if self.cluster_environment is not None else 0
@property
def node_rank(self) -> int:
return self.cluster_environment.node_rank() if self.cluster_environment is not None else 0
@property
def world_size(self) -> int:
return self.cluster_environment.world_size() if self.cluster_environment is not None else 1
@property
def is_global_zero(self) -> bool:
return self.global_rank == 0
@property
def parallel_devices(self):
return self._parallel_devices
@parallel_devices.setter
def parallel_devices(self, parallel_devices):
self._parallel_devices = parallel_devices
@property
def distributed_sampler_kwargs(self):
distributed_sampler_kwargs = dict(num_replicas=len(self.parallel_devices), rank=self.global_rank)
return distributed_sampler_kwargs
@property
def torch_distributed_backend(self) -> str:
"""Deprecated property."""
rank_zero_deprecation(
"ParallelStrategy.torch_distributed_backend was deprecated in v1.6 and will be removed in v1.8."
)
pg_backend = _get_process_group_backend_from_env()
if pg_backend:
return pg_backend
return get_default_process_group_backend_for_device(self.root_device)
[docs] def reconciliate_processes(self, trace: str):
"""Function to re-conciliate processes on failure."""
[docs] def all_gather(self, tensor: torch.Tensor, group: Optional[Any] = None, sync_grads: bool = False) -> torch.Tensor:
"""Perform a all_gather on all processes."""
return all_gather_ddp_if_available(tensor, group=group, sync_grads=sync_grads)
[docs] def reduce_boolean_decision(self, decision: bool) -> bool:
decision = torch.tensor(int(decision), device=self.root_device)
decision = self.reduce(decision, reduce_op=ReduceOp.SUM)
decision = bool(decision == self.world_size)
return decision
[docs] @contextmanager
def block_backward_sync(self):
"""Blocks ddp sync gradients behaviour on backwards pass.
This is useful for skipping sync when accumulating gradients, reducing communication overhead
Returns: context manager with sync behaviour off
"""
if isinstance(self.model, DistributedDataParallel):
with self.model.no_sync():
yield None
else:
yield None
