Deprecate ProgressBar and rename it to TQDMProgressBar

CHANGELOG.md

@@ -454,6 +454,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Deprecated `lr_sch_names` from `LearningRateMonitor` ([#10066](https://github.com/PyTorchLightning/pytorch-lightning/pull/10066))
 
 
+- Deprecated `ProgressBar` callback in favor of `TQDMProgressBar` ([#10134](https://github.com/PyTorchLightning/pytorch-lightning/pull/10134))
+
+
 ### Removed
 
 - Removed deprecated `metrics` ([#8586](https://github.com/PyTorchLightning/pytorch-lightning/pull/8586/))

pytorch_lightning/callbacks/__init__.py

@@ -22,7 +22,7 @@
 from pytorch_lightning.callbacks.model_checkpoint import ModelCheckpoint
 from pytorch_lightning.callbacks.model_summary import ModelSummary
 from pytorch_lightning.callbacks.prediction_writer import BasePredictionWriter
-from pytorch_lightning.callbacks.progress import ProgressBar, ProgressBarBase, RichProgressBar
+from pytorch_lightning.callbacks.progress import ProgressBar, ProgressBarBase, RichProgressBar, TQDMProgressBar
 from pytorch_lightning.callbacks.pruning import ModelPruning
 from pytorch_lightning.callbacks.quantization import QuantizationAwareTraining
 from pytorch_lightning.callbacks.rich_model_summary import RichModelSummary
@@ -52,4 +52,5 @@
     "RichProgressBar",
     "StochasticWeightAveraging",
     "Timer",
+    "TQDMProgressBar",
 ]

pytorch_lightning/callbacks/progress/__init__.py

@@ -19,5 +19,6 @@
 
 """
 from pytorch_lightning.callbacks.progress.base import ProgressBarBase  # noqa: F401
+from pytorch_lightning.callbacks.progress.progress import ProgressBar  # noqa: F401
 from pytorch_lightning.callbacks.progress.rich_progress import RichProgressBar  # noqa: F401
-from pytorch_lightning.callbacks.progress.tqdm_progress import ProgressBar  # noqa: F401
+from pytorch_lightning.callbacks.progress.tqdm_progress import TQDMProgressBar  # noqa: F401

pytorch_lightning/callbacks/progress/progress.py

@@ -0,0 +1,24 @@
+# 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.callbacks.progress.tqdm_progress import TQDMProgressBar
+from pytorch_lightning.utilities import rank_zero_deprecation
+
+
+class ProgressBar(TQDMProgressBar):
+    def __init__(self, *args, **kwargs)
+        super().__init__(*args, **kwargs)
+        rank_zero_deprecation(
+            "`ProgressBar` has been deprecated in v1.5 and will be removed in v1.7."
+            " It has been renamed to `TQDMProgressBar` instead."
+        )

pytorch_lightning/callbacks/progress/tqdm_progress.py

@@ -54,7 +54,7 @@ def format_num(n) -> str:
         return n
 
 
-class ProgressBar(ProgressBarBase):
+class TQDMProgressBar(ProgressBarBase):
     r"""
     This is the default progress bar used by Lightning. It prints to ``stdout`` using the
     :mod:`tqdm` package and shows up to four different bars:
@@ -75,7 +75,7 @@ class ProgressBar(ProgressBarBase):
 
     Example:
 
-        >>> class LitProgressBar(ProgressBar):
+        >>> class LitProgressBar(TQDMProgressBar):
         ...     def init_validation_tqdm(self):
         ...         bar = super().init_validation_tqdm()
         ...         bar.set_description('running validation ...')

pytorch_lightning/trainer/connectors/callback_connector.py

@@ -20,9 +20,9 @@
     GradientAccumulationScheduler,
     ModelCheckpoint,
     ModelSummary,
-    ProgressBar,
     ProgressBarBase,
     RichProgressBar,
+    TQDMProgressBar,
 )
 from pytorch_lightning.callbacks.rich_model_summary import RichModelSummary
 from pytorch_lightning.callbacks.timer import Timer
@@ -230,7 +230,7 @@ def configure_progress_bar(self, refresh_rate=None, process_position=0):
         if len(progress_bars) == 1:
             progress_bar_callback = progress_bars[0]
         elif refresh_rate > 0:
-            progress_bar_callback = ProgressBar(refresh_rate=refresh_rate, process_position=process_position)
+            progress_bar_callback = TQDMProgressBar(refresh_rate=refresh_rate, process_position=process_position)
             self.trainer.callbacks.append(progress_bar_callback)
         else:
             progress_bar_callback = None

tests/deprecated_api/test_remove_1-7.py

@@ -20,6 +20,7 @@
 from pytorch_lightning import Callback, LightningDataModule, Trainer
 from pytorch_lightning.callbacks.gpu_stats_monitor import GPUStatsMonitor
 from pytorch_lightning.callbacks.lr_monitor import LearningRateMonitor
+from pytorch_lightning.callbacks.progress import ProgressBar
 from pytorch_lightning.callbacks.xla_stats_monitor import XLAStatsMonitor
 from pytorch_lightning.loggers import LoggerCollection, TestTubeLogger
 from tests.callbacks.test_callbacks import OldStatefulCallback
@@ -391,6 +392,11 @@ def test_v1_7_0_deprecate_xla_stats_monitor(tmpdir):
         _ = XLAStatsMonitor()
 
 
+def test_v1_7_0_progress_bar():
+    with pytest.deprecated_call(match="has been deprecated in v1.5 and will be removed in v1.7."):
+        _ = ProgressBar()
+
+
 def test_v1_7_0_deprecated_max_steps_none(tmpdir):
     with pytest.deprecated_call(match="`max_steps = None` is deprecated in v1.5"):
         _ = Trainer(max_steps=None)