Add backward-compatibility for LightningLite in PL (#14735)

Author: awaelchli

examples/convert_from_pt_to_pl/image_classifier_2_lite.py

@@ -38,10 +38,10 @@
 from torch.optim.lr_scheduler import StepLR
 from torchmetrics.classification import Accuracy
 
-from lightning_lite.lite import LightningLite  # import LightningLite
 from pytorch_lightning import seed_everything
 from pytorch_lightning.demos.boring_classes import Net
 from pytorch_lightning.demos.mnist_datamodule import MNIST
+from pytorch_lightning.lite import LightningLite  # import LightningLite
 
 DATASETS_PATH = path.join(path.dirname(__file__), "..", "..", "Datasets")
 

examples/convert_from_pt_to_pl/image_classifier_3_lite_to_lightning_module.py

@@ -34,10 +34,10 @@
 from torch.optim.lr_scheduler import StepLR
 from torchmetrics import Accuracy
 
-from lightning_lite.lite import LightningLite
 from pytorch_lightning import seed_everything
 from pytorch_lightning.demos.boring_classes import Net
 from pytorch_lightning.demos.mnist_datamodule import MNIST
+from pytorch_lightning.lite import LightningLite
 
 DATASETS_PATH = path.join(path.dirname(__file__), "..", "..", "Datasets")
 

examples/pl_loops/mnist_lite.py

@@ -22,10 +22,10 @@
 from torch.optim.lr_scheduler import StepLR
 from torchmetrics import Accuracy
 
-from lightning_lite.lite import LightningLite
 from pytorch_lightning import seed_everything
 from pytorch_lightning.demos.boring_classes import Net
 from pytorch_lightning.demos.mnist_datamodule import MNIST
+from pytorch_lightning.lite import LightningLite
 from pytorch_lightning.loops import Loop
 
 DATASETS_PATH = path.join(path.dirname(__file__), "..", "..", "Datasets")

src/lightning_lite/connector.py

@@ -52,11 +52,11 @@
     XLAStrategy,
 )
 from lightning_lite.strategies.ddp_spawn import _DDP_FORK_ALIASES
-from lightning_lite.utilities import _StrategyType, rank_zero_deprecation, rank_zero_info, rank_zero_warn
+from lightning_lite.utilities import _StrategyType, rank_zero_info, rank_zero_warn
 from lightning_lite.utilities.device_parser import determine_root_gpu_device
 from lightning_lite.utilities.imports import _HPU_AVAILABLE, _IPU_AVAILABLE, _IS_INTERACTIVE, _TPU_AVAILABLE
 
-_PLUGIN = Union[Strategy, Precision, ClusterEnvironment, CheckpointIO]
+_PLUGIN = Union[Precision, ClusterEnvironment, CheckpointIO]
 _PLUGIN_INPUT = Union[_PLUGIN, str]
 
 
@@ -99,8 +99,6 @@ def __init__(
         num_nodes: int = 1,
         precision: Union[int, str] = 32,
         plugins: Optional[Union[_PLUGIN_INPUT, List[_PLUGIN_INPUT]]] = None,
-        tpu_cores: Optional[Union[List[int], str, int]] = None,  # deprecated
-        gpus: Optional[Union[List[int], str, int]] = None,  # deprecated
     ) -> None:
         # 1. Parsing flags
         # Get registered strategies, built-in accelerators and precision plugins
@@ -125,9 +123,7 @@ def __init__(
             precision=precision,
             plugins=plugins,
         )
-        self._check_device_config_and_set_final_flags(
-            devices=devices, num_nodes=num_nodes, gpus=gpus, tpu_cores=tpu_cores
-        )
+        self._check_device_config_and_set_final_flags(devices=devices, num_nodes=num_nodes)
 
         # 2. Instantiate Accelerator
         # handle `auto`, `None` and `gpu`
@@ -278,11 +274,7 @@ def _check_config_and_set_final_flags(
                     self._parallel_devices = self._strategy_flag.parallel_devices
 
     def _check_device_config_and_set_final_flags(
-        self,
-        devices: Optional[Union[List[int], str, int]],
-        num_nodes: int,
-        gpus: Optional[Union[List[int], str, int]],
-        tpu_cores: Optional[Union[List[int], str, int]],
+        self, devices: Optional[Union[List[int], str, int]], num_nodes: int
     ) -> None:
         self._num_nodes_flag = int(num_nodes) if num_nodes is not None else 1
         self._devices_flag = devices
@@ -298,56 +290,12 @@ def _check_device_config_and_set_final_flags(
                 f" using {accelerator_name} accelerator."
             )
 
-        # TODO: Delete this method when num_processes, gpus, ipus and tpu_cores gets removed
-        self._map_deprecated_devices_specific_info_to_accelerator_and_device_flag(devices, gpus, tpu_cores)
-
         if self._devices_flag == "auto" and self._accelerator_flag is None:
             raise ValueError(
                 f"You passed `devices={devices}` but haven't specified"
                 " `accelerator=('auto'|'tpu'|'gpu'|'cpu'|'mps')` for the devices mapping."
             )
 
-    def _map_deprecated_devices_specific_info_to_accelerator_and_device_flag(
-        self,
-        devices: Optional[Union[List[int], str, int]],
-        gpus: Optional[Union[List[int], str, int]],
-        tpu_cores: Optional[Union[List[int], str, int]],
-    ) -> None:
-        """Emit deprecation warnings for num_processes, gpus, ipus, tpu_cores and set the `devices_flag` and
-        `accelerator_flag`."""
-        if gpus is not None:
-            rank_zero_deprecation(
-                f"Setting `Lite(gpus={gpus!r})` is deprecated in v1.7 and will be removed"
-                f" in v2.0. Please use `Lite(accelerator='gpu', devices={gpus!r})` instead."
-            )
-        if tpu_cores is not None:
-            rank_zero_deprecation(
-                f"Setting `Lite(tpu_cores={tpu_cores!r})` is deprecated in v1.7 and will be removed"
-                f" in v2.0. Please use `Lite(accelerator='tpu', devices={tpu_cores!r})` instead."
-            )
-        self._gpus: Optional[Union[List[int], str, int]] = gpus
-        self._tpu_cores: Optional[Union[List[int], str, int]] = tpu_cores
-        deprecated_devices_specific_flag = gpus or tpu_cores
-        if deprecated_devices_specific_flag and deprecated_devices_specific_flag not in ([], 0, "0"):
-            if devices:
-                # TODO: improve error message
-                rank_zero_warn(
-                    f"The flag `devices={devices}` will be ignored, "
-                    f"instead the device specific number {deprecated_devices_specific_flag} will be used"
-                )
-
-            if [(gpus is not None), (tpu_cores is not None)].count(True) > 1:
-                # TODO: improve error message
-                rank_zero_warn("more than one device specific flag has been set")
-            self._devices_flag = deprecated_devices_specific_flag
-
-            if self._accelerator_flag is None:
-                # set accelerator type based on num_processes, gpus, ipus, tpu_cores
-                if tpu_cores:
-                    self._accelerator_flag = "tpu"
-                if gpus:
-                    self._accelerator_flag = "cuda"
-
     def _choose_auto_accelerator(self) -> str:
         """Choose the accelerator type (str) based on availability when ``accelerator='auto'``."""
         if self._accelerator_flag == "auto":
@@ -392,9 +340,6 @@ def _set_parallel_devices_and_init_accelerator(self) -> None:
 
         self._set_devices_flag_if_auto_passed()
 
-        self._gpus = self._devices_flag if not self._gpus else self._gpus
-        self._tpu_cores = self._devices_flag if not self._tpu_cores else self._tpu_cores
-
         self._devices_flag = self.accelerator.parse_devices(self._devices_flag)
         if not self._parallel_devices:
             self._parallel_devices = self.accelerator.get_parallel_devices(self._devices_flag)

src/lightning_lite/lite.py

@@ -64,8 +64,6 @@ class LightningLite(ABC):
         precision: Double precision (``64``), full precision (``32``), half precision (``16``),
             or bfloat16 precision (``"bf16"``).
         plugins: One or several custom plugins
-        gpus: Provides the same function as the ``devices`` argument but implies ``accelerator="gpu"``.
-        tpu_cores: Provides the same function as the ``devices`` argument but implies ``accelerator="tpu"``.
     """
 
     def __init__(
@@ -76,8 +74,6 @@ def __init__(
         num_nodes: int = 1,
         precision: Union[int, str] = 32,
         plugins: Optional[Union[_PLUGIN_INPUT, List[_PLUGIN_INPUT]]] = None,
-        gpus: Optional[Union[List[int], str, int]] = None,
-        tpu_cores: Optional[Union[List[int], str, int]] = None,
     ) -> None:
         self._connector = _Connector(
             accelerator=accelerator,
@@ -86,8 +82,6 @@ def __init__(
             num_nodes=num_nodes,
             precision=precision,
             plugins=plugins,
-            tpu_cores=tpu_cores,
-            gpus=gpus,
         )
         self._strategy: Strategy = self._connector.strategy
         self._accelerator: Accelerator = self._connector.accelerator

src/lightning_lite/plugins/precision/__init__.py

@@ -11,15 +11,17 @@
 # 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 lightning_lite.plugins.precision.precision import Precision  # isort:skip
 from lightning_lite.plugins.precision.deepspeed import DeepSpeedPrecision
+from lightning_lite.plugins.precision.double import DoublePrecision
 from lightning_lite.plugins.precision.mixed import MixedPrecision
 from lightning_lite.plugins.precision.native_amp import NativeMixedPrecision
-from lightning_lite.plugins.precision.precision import Precision
 from lightning_lite.plugins.precision.tpu import TPUPrecision
 from lightning_lite.plugins.precision.tpu_bf16 import TPUBf16Precision
 
 __all__ = [
     "DeepSpeedPrecision",
+    "DoublePrecision",
     "MixedPrecision",
     "NativeMixedPrecision",
     "Precision",

src/lightning_lite/strategies/xla.py

@@ -54,7 +54,6 @@ def __init__(
         parallel_devices: Optional[List[torch.device]] = None,
         checkpoint_io: Optional[CheckpointIO] = None,
         precision_plugin: Optional[Precision] = None,
-        **_: Any,
     ) -> None:
         super().__init__(
             accelerator=accelerator,

src/pytorch_lightning/callbacks/early_stopping.py

@@ -261,7 +261,9 @@ def _improvement_message(self, current: Tensor) -> str:
 
     @staticmethod
     def _log_info(trainer: Optional["pl.Trainer"], message: str, log_rank_zero_only: bool) -> None:
-        rank = _get_rank(strategy=(trainer.strategy if trainer is not None else None))  # type: ignore[arg-type]
+        rank = _get_rank(
+            strategy=(trainer.strategy if trainer is not None else None),  # type: ignore[arg-type]
+        )
         if trainer is not None and trainer.world_size <= 1:
             rank = None
         message = rank_prefixed_message(message, rank)

src/pytorch_lightning/lite/__init__.py

@@ -0,0 +1,17 @@
+# 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 pytorch_lightning.lite.lite import LightningLite
+
+__all__ = ["LightningLite"]