Remove deprecated rank zero utilities (#14471)

Co-authored-by: Jirka Borovec <[email protected]>

Author: carmocca

src/pytorch_lightning/CHANGELOG.md

@@ -110,6 +110,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Removed deprecated support for old torchtext versions ([#14375](https://github.com/Lightning-AI/lightning/pull/14375))
 
 
+- Remove the deprecated ([#14471](https://github.com/Lightning-AI/lightning/pull/14471))
+  * `pytorch_lightning.utilities.distributed.rank_zero_only` in favor of `pytorch_lightning.utilities.rank_zero.rank_zero_only`
+  * `pytorch_lightning.utilities.distributed.rank_zero_debug` in favor of `pytorch_lightning.utilities.rank_zero.rank_zero_debug`
+  * `pytorch_lightning.utilities.distributed.rank_zero_info` in favor of `pytorch_lightning.utilities.rank_zero.rank_zero_info`
+  * `pytorch_lightning.utilities.warnings.rank_zero_warn` in favor of `pytorch_lightning.utilities.rank_zero.rank_zero_warn`
+  * `pytorch_lightning.utilities.warnings.rank_zero_deprecation` in favor of `pytorch_lightning.utilities.rank_zero.rank_zero_deprecation`
+  * `pytorch_lightning.utilities.warnings.LightningDeprecationWarning` in favor of `pytorch_lightning.utilities.rank_zero.LightningDeprecationWarning`
+
+
 - Removed deprecated `Trainer.num_processes` attribute in favour of `Trainer.num_devices` ([#14423](https://github.com/Lightning-AI/lightning/pull/14423))
 
 
@@ -634,7 +643,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Deprecated `pytorch_lightning.utilities.distributed.rank_zero_info` in favor of `pytorch_lightning.utilities.rank_zero.rank_zero_info` ([#11747](https://github.com/Lightning-AI/lightning/pull/11747))
 - Deprecated `pytorch_lightning.utilities.warnings.rank_zero_warn` in favor of `pytorch_lightning.utilities.rank_zero.rank_zero_warn` ([#11747](https://github.com/Lightning-AI/lightning/pull/11747))
 - Deprecated `pytorch_lightning.utilities.warnings.rank_zero_deprecation` in favor of `pytorch_lightning.utilities.rank_zero.rank_zero_deprecation` ([#11747](https://github.com/Lightning-AI/lightning/pull/11747))
-- Deprecated `pytorch_lightning.utilities.warnings.LightningDeprecationWarning` in favor of `pytorch_lightning.utilities.rank_zero.LightningDeprecationWarning`
+- Deprecated `pytorch_lightning.utilities.warnings.LightningDeprecationWarning` in favor of `pytorch_lightning.utilities.rank_zero.LightningDeprecationWarning` ([#11747](https://github.com/Lightning-AI/lightning/pull/11747))
 - Deprecated `on_pretrain_routine_start` and `on_pretrain_routine_end` callback hooks in favor of `on_fit_start` ([#11794](https://github.com/Lightning-AI/lightning/pull/11794))
 - Deprecated `LightningModule.on_pretrain_routine_start` and `LightningModule.on_pretrain_routine_end` hooks in favor of `on_fit_start` ([#12122](https://github.com/Lightning-AI/lightning/pull/12122))
 - Deprecated `agg_key_funcs` and `agg_default_func` parameters from `LightningLoggerBase` ([#11871](https://github.com/Lightning-AI/lightning/pull/11871))

src/pytorch_lightning/loggers/base.py

@@ -17,7 +17,7 @@
 import numpy as np
 
 import pytorch_lightning.loggers.logger as logger
-from pytorch_lightning.utilities.warnings import rank_zero_deprecation
+from pytorch_lightning.utilities.rank_zero import rank_zero_deprecation
 
 
 def rank_zero_experiment(fn: Callable) -> Callable:

src/pytorch_lightning/strategies/parallel.py

@@ -30,7 +30,7 @@
     get_default_process_group_backend_for_device,
     ReduceOp,
 )
-from pytorch_lightning.utilities.warnings import rank_zero_deprecation
+from pytorch_lightning.utilities.rank_zero import rank_zero_deprecation
 
 
 class ParallelStrategy(Strategy, ABC):

src/pytorch_lightning/utilities/distributed.py

@@ -23,10 +23,8 @@
 
 import pytorch_lightning as pl
 from pytorch_lightning.utilities.imports import _HPU_AVAILABLE, _TPU_AVAILABLE
-from pytorch_lightning.utilities.rank_zero import rank_zero_debug as new_rank_zero_debug
 from pytorch_lightning.utilities.rank_zero import rank_zero_only  # noqa: F401
-from pytorch_lightning.utilities.rank_zero import rank_zero_deprecation
-from pytorch_lightning.utilities.rank_zero import rank_zero_info as new_rank_zero_info
+from pytorch_lightning.utilities.rank_zero import rank_zero_debug, rank_zero_deprecation, rank_zero_info
 
 if _TPU_AVAILABLE:
     import torch_xla.core.xla_model as xm
@@ -160,7 +158,7 @@ def sync_ddp(result: Tensor, group: Optional[Any] = None, reduce_op: Optional[Un
         is_hpu_backend = os.environ.get("HCCL_DISTRIBUTED_BACKEND") == "1"
         if is_hpu_backend:
             if (result.type() == "torch.LongTensor") or (result.type() == "torch.hpu.LongTensor"):
-                new_rank_zero_info("Long tensor unsupported on HPU, casting to float")
+                rank_zero_info("Long tensor unsupported on HPU, casting to float")
                 result = result.float()
 
     # sync all processes before reduction
@@ -312,12 +310,12 @@ def register_ddp_comm_hook(
     ddp_comm_hook: Callable = ddp_comm_hook
 
     if ddp_comm_wrapper is not None:
-        new_rank_zero_info(
+        rank_zero_info(
             f"DDP comm wrapper is provided, apply {ddp_comm_wrapper.__qualname__}({ddp_comm_hook.__qualname__})."
         )
         ddp_comm_hook = ddp_comm_wrapper(ddp_comm_hook)
 
-    new_rank_zero_debug(f"Registering DDP comm hook: {ddp_comm_hook.__qualname__}.")
+    rank_zero_debug(f"Registering DDP comm hook: {ddp_comm_hook.__qualname__}.")
     model.register_comm_hook(state=ddp_comm_state, hook=ddp_comm_hook)  # type: ignore[operator]
 
 
@@ -374,7 +372,7 @@ def init_dist_connection(
     torch.distributed.init_process_group(torch_distributed_backend, rank=global_rank, world_size=world_size, **kwargs)
 
     # on rank=0 let everyone know training is starting
-    new_rank_zero_info(
+    rank_zero_info(
         f"{'-' * 100}\n"
         f"distributed_backend={torch_distributed_backend}\n"
         f"All distributed processes registered. Starting with {world_size} processes\n"
@@ -402,21 +400,3 @@ def _collect_states_on_rank_zero(state: Dict[str, Any]) -> Dict[int, Any]:
     if not distributed_available():
         return {0: state}
     return {rank: _broadcast_object_list(state, rank) for rank in range(torch.distributed.get_world_size())}
-
-
-def rank_zero_info(*args: Any, **kwargs: Any) -> Any:
-    rank_zero_deprecation(
-        "pytorch_lightning.utilities.distributed.rank_zero_info has been deprecated in v1.6"
-        " and will be removed in v1.8."
-        " Use the equivalent function from the pytorch_lightning.utilities.rank_zero module instead."
-    )
-    return new_rank_zero_info(*args, **kwargs)
-
-
-def rank_zero_debug(*args: Any, **kwargs: Any) -> Any:
-    rank_zero_deprecation(
-        "pytorch_lightning.utilities.distributed.rank_zero_debug has been deprecated in v1.6"
-        " and will be removed in v1.8."
-        " Use the equivalent function from the pytorch_lightning.utilities.rank_zero module instead."
-    )
-    return new_rank_zero_debug(*args, **kwargs)

src/pytorch_lightning/utilities/warnings.py

@@ -12,17 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Warning-related utilities."""
-
 import warnings
 from typing import Any
 
-from pytorch_lightning.utilities.rank_zero import LightningDeprecationWarning as NewLightningDeprecationWarning
-from pytorch_lightning.utilities.rank_zero import rank_zero_deprecation as new_rank_zero_deprecation
-from pytorch_lightning.utilities.rank_zero import rank_zero_info as new_rank_zero_info
-from pytorch_lightning.utilities.rank_zero import rank_zero_warn as new_rank_zero_warn
+from pytorch_lightning.utilities.rank_zero import (
+    LightningDeprecationWarning,
+    rank_zero_deprecation,
+    rank_zero_info,
+    rank_zero_warn,
+)
 
 # enable our warnings
-warnings.simplefilter("default", category=NewLightningDeprecationWarning)
+
+warnings.simplefilter("default", category=LightningDeprecationWarning)
 
 
 class PossibleUserWarning(UserWarning):
@@ -33,42 +35,14 @@ class WarningCache(set):
     def warn(self, message: str, stacklevel: int = 5, **kwargs: Any) -> None:
         if message not in self:
             self.add(message)
-            new_rank_zero_warn(message, stacklevel=stacklevel, **kwargs)
+            rank_zero_warn(message, stacklevel=stacklevel, **kwargs)
 
     def deprecation(self, message: str, stacklevel: int = 5, **kwargs: Any) -> None:
         if message not in self:
             self.add(message)
-            new_rank_zero_deprecation(message, stacklevel=stacklevel, **kwargs)
+            rank_zero_deprecation(message, stacklevel=stacklevel, **kwargs)
 
     def info(self, message: str, stacklevel: int = 5, **kwargs: Any) -> None:
         if message not in self:
             self.add(message)
-            new_rank_zero_info(message, stacklevel=stacklevel, **kwargs)
-
-
-def rank_zero_warn(*args: Any, **kwargs: Any) -> Any:
-    new_rank_zero_deprecation(
-        "pytorch_lightning.utilities.warnings.rank_zero_warn has been deprecated in v1.6"
-        " and will be removed in v1.8."
-        " Use the equivalent function from the pytorch_lightning.utilities.rank_zero module instead."
-    )
-    return new_rank_zero_warn(*args, **kwargs)
-
-
-def rank_zero_deprecation(*args: Any, **kwargs: Any) -> Any:
-    new_rank_zero_deprecation(
-        "pytorch_lightning.utilities.warnings.rank_zero_deprecation has been deprecated in v1.6"
-        " and will be removed in v1.8."
-        " Use the equivalent function from the pytorch_lightning.utilities.rank_zero module instead."
-    )
-    return new_rank_zero_deprecation(*args, **kwargs)
-
-
-class LightningDeprecationWarning(NewLightningDeprecationWarning):
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        new_rank_zero_deprecation(
-            "pytorch_lightning.utilities.warnings.LightningDeprecationWarning has been deprecated in v1.6"
-            " and will be removed in v1.8."
-            " Use the equivalent class from the pytorch_lightning.utilities.rank_zero module instead."
-        )
-        super().__init__(*args, **kwargs)
+            rank_zero_info(message, stacklevel=stacklevel, **kwargs)

tests/tests_pytorch/deprecated_api/test_remove_1-8.py

@@ -275,40 +275,6 @@ def on_pretrain_routine_end(self, *args, **kwargs):
         trainer.fit(model)
 
 
-def test_v1_8_0_rank_zero_imports():
-
-    import warnings
-
-    from pytorch_lightning.utilities.distributed import rank_zero_debug, rank_zero_info
-    from pytorch_lightning.utilities.warnings import LightningDeprecationWarning, rank_zero_deprecation, rank_zero_warn
-
-    with pytest.deprecated_call(
-        match="pytorch_lightning.utilities.distributed.rank_zero_debug has been deprecated in v1.6"
-        " and will be removed in v1.8."
-    ):
-        rank_zero_debug("foo")
-    with pytest.deprecated_call(
-        match="pytorch_lightning.utilities.distributed.rank_zero_info has been deprecated in v1.6"
-        " and will be removed in v1.8."
-    ):
-        rank_zero_info("foo")
-    with pytest.deprecated_call(
-        match="pytorch_lightning.utilities.warnings.rank_zero_warn has been deprecated in v1.6"
-        " and will be removed in v1.8."
-    ):
-        rank_zero_warn("foo")
-    with pytest.deprecated_call(
-        match="pytorch_lightning.utilities.warnings.rank_zero_deprecation has been deprecated in v1.6"
-        " and will be removed in v1.8."
-    ):
-        rank_zero_deprecation("foo")
-    with pytest.deprecated_call(
-        match="pytorch_lightning.utilities.warnings.LightningDeprecationWarning has been deprecated in v1.6"
-        " and will be removed in v1.8."
-    ):
-        warnings.warn("foo", LightningDeprecationWarning, stacklevel=5)
-
-
 def test_v1_8_0_on_before_accelerator_backend_setup(tmpdir):
     class TestCallback(Callback):
         def on_before_accelerator_backend_setup(self, *args, **kwargs):