Change Deprecation Warnings to Warnings for specifying ProgressBarLogger and ConsoleLogger to loggers (#1846)

changes DeprecationWarning -> Warning for adding ProgressBarLogger and ConsoleLogger to loggers

Author: eracah

composer/trainer/trainer.py

@@ -1094,23 +1094,23 @@ def __init__(
 
         if any(isinstance(x, ProgressBarLogger) for x in loggers):
             warnings.warn(
-                DeprecationWarning(
-                    (f'Specifying the {ProgressBarLogger.__name__} via `loggers` is deprecated. Instead, '
-                     'please specify `progress_bar`, `console_stream` and `log_traces` arguments when '
-                     'constructing the trainer. If specified, these arguments will be ignored, as the '
-                     f'{ProgressBarLogger.__name__} was already created.')))
+                Warning((
+                    f'Specifying the {ProgressBarLogger.__name__} via `loggers` is not recommended as '
+                    'any values set for the following Trainer arguments will be ignored: `progress_bar`, `console_stream`, or `log_traces`. '
+                    'The recommended way of enabling a progress bar is to set `progress_bar` to True instead of '
+                    f'constructing a {ProgressBarLogger.__name__} instance.')))
         else:
             if progress_bar:
                 loggers.append(ProgressBarLogger(stream=console_stream, log_traces=log_traces))
 
         # Console Logging
         if any(isinstance(x, ConsoleLogger) for x in loggers):
             warnings.warn(
-                DeprecationWarning((
-                    f'Specifying the {ConsoleLogger.__name__} via `loggers` is deprecated. Instead, '
-                    'please specify `log_to_console`, `console_stream`, `console_log_interval`, and `log_traces` arguments when '
-                    'constructing the trainer. If specified, these arguments will be ignored, as the '
-                    f'{ConsoleLogger.__name__} was already created.')))
+                Warning((
+                    f'Specifying the {ConsoleLogger.__name__} via `loggers` is not recommended as '
+                    'any values set for the following Trainer arguments will be ignored: `log_to_console`, `console_stream`, `log_traces`, and `console_log_interval`. '
+                    'The recommended way of enabling a console logging is to set `log_to_console` to True instead of '
+                    f'constructing a {ConsoleLogger.__name__} instance.')))
         else:
             if log_to_console:
                 loggers.append(

tests/callbacks/test_callbacks.py

@@ -8,7 +8,7 @@
 
 from composer.core import Callback, Engine, Event, State
 from composer.core.time import Time
-from composer.loggers import Logger, LoggerDestination
+from composer.loggers import ConsoleLogger, Logger, LoggerDestination, ProgressBarLogger
 from composer.profiler import Profiler, ProfilerAction
 from composer.trainer import Trainer
 from tests.callbacks.callback_settings import get_cb_kwargs, get_cbs_and_marks
@@ -131,6 +131,8 @@ def _get_trainer(self, cb: Callback, grad_accum: int):
         )
 
     def test_trains(self, cb_cls: Type[Callback], grad_accum: int, _remote: bool):
+        if cb_cls in [ProgressBarLogger, ConsoleLogger]:
+            pytest.skip()
         del _remote  # unused. `_remote` must be passed through to parameterize the test markers.
         cb_kwargs = get_cb_kwargs(cb_cls)
         cb = cb_cls(**cb_kwargs)
@@ -143,6 +145,8 @@ def test_trains_multiple_calls(self, cb_cls: Type[Callback], grad_accum: int, _r
         Note: future functional tests should test for
         idempotency (e.g functionally)
         """
+        if cb_cls in [ProgressBarLogger, ConsoleLogger]:
+            pytest.skip()
         del _remote  # unused. `_remote` must be passed through to parameterize the test markers.
         cb_kwargs = get_cb_kwargs(cb_cls)
         cb = cb_cls(**cb_kwargs)

tests/callbacks/test_loggers_across_callbacks.py

@@ -8,7 +8,7 @@
 from torch.utils.data import DataLoader
 
 from composer.core import Callback
-from composer.loggers import LoggerDestination
+from composer.loggers import ConsoleLogger, LoggerDestination, ProgressBarLogger
 from composer.loggers.remote_uploader_downloader import RemoteUploaderDownloader
 from composer.trainer import Trainer
 from tests.callbacks.callback_settings import get_cb_kwargs, get_cbs_and_marks
@@ -18,6 +18,8 @@
 @pytest.mark.parametrize('logger_cls', get_cbs_and_marks(loggers=True))
 @pytest.mark.parametrize('callback_cls', get_cbs_and_marks(callbacks=True))
 def test_loggers_on_callbacks(logger_cls: Type[LoggerDestination], callback_cls: Type[Callback]):
+    if logger_cls in [ProgressBarLogger, ConsoleLogger]:
+        pytest.skip()
     logger_kwargs = get_cb_kwargs(logger_cls)
     if issubclass(logger_cls, RemoteUploaderDownloader):
         # Ensure that the remote directory does not conflict with any directory used by callbacks

tests/loggers/test_console_logger.py

@@ -11,6 +11,7 @@
 
 from composer.callbacks import SpeedMonitor
 from composer.core import Evaluator
+from composer.loggers import ConsoleLogger
 from composer.loggers.console_logger import NUM_EVAL_LOGGING_EVENTS
 from composer.trainer import Trainer
 from tests.common import RandomClassificationDataset, SimpleModel
@@ -163,11 +164,10 @@ def test_console_logger_interval_with_eval(console_logger_test_stream, console_l
 
 def test_log_to_console_and_progress_bar_warning():
     with pytest.warns(Warning):
-        Trainer(model=SimpleModel(),
-                log_to_console=True,
-                progress_bar=True,
-                train_dataloader=DataLoader(RandomClassificationDataset()),
-                max_duration=f'2ep')
+        Trainer(model=SimpleModel(), log_to_console=True, progress_bar=True)
+
+    with pytest.warns(Warning):
+        Trainer(model=SimpleModel(), loggers=ConsoleLogger())
 
 
 @pytest.mark.parametrize('log_interval_unit', ['ba', 'ep'])

tests/loggers/test_progress_bar_logger.py

@@ -9,6 +9,7 @@
 from tqdm import auto
 
 from composer.core.time import Time, TimeUnit
+from composer.loggers import ProgressBarLogger
 from composer.trainer.trainer import Trainer
 from composer.utils import dist
 from tests.common import RandomClassificationDataset, SimpleModel
@@ -96,3 +97,8 @@ def get_mock_tqdm(bar_format: str, *args: object, **kwargs: object):
     # test eval pbar
     for mt in mock_tqdms_eval:
         assert mt.update.call_count == eval_subset_num_batches
+
+
+def test_progress_bar_warning():
+    with pytest.warns(Warning):
+        Trainer(model=SimpleModel(), loggers=ProgressBarLogger())