Move contrib.handlers (#3204)

* migrate ignite.contrib.handlers move loggers and other class from contrib to ignite.handlers make changes in a backwards compatible manner fix circular imports that happened during the migration in ignite/__init__.py and ignite/handlers/__init__.py * update tests move tests to ignite.handlers along with fixtures and changing the imports add a test to ensure deprecation warnings for ignite.contrib.handlers * improve docs mark as deprecated and provide link to migrated functionality * make alternative fix for circular import * add modules to contrib handlers namespace previously this occured as a side effect, adding it explicitly now.
pytorch · Mar 22, 2024 · 1e7d336 · 1e7d336
1 parent 5fe7443
commit 1e7d336
Show file tree

Hide file tree

Showing 43 changed files with 5,103 additions and 4,697 deletions.
diff --git a/docs/source/contrib/handlers.rst b/docs/source/contrib/handlers.rst
@@ -25,40 +25,8 @@ Time profilers [deprecated]
     Use :class:`~ignite.handlers.time_profilers.BasicTimeProfiler` instead, will be removed in version 0.6.0.
     Use :class:`~ignite.handlers.time_profilers.HandlersTimeProfiler` instead, will be removed in version 0.6.0.
 
-Loggers
--------
+Loggers [deprecated]
+--------------------
 
-.. currentmodule:: ignite.contrib.handlers
-
-.. autosummary::
-    :nosignatures:
-    :toctree: ../generated
-    :recursive:
-
-    base_logger
-    clearml_logger
-    mlflow_logger
-    neptune_logger
-    polyaxon_logger
-    tensorboard_logger
-    tqdm_logger
-
-    visdom_logger
-    wandb_logger
-
-.. seealso::
-
-    Below are a comprehensive list of examples of various loggers.
-
-    * See `tensorboardX mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_tensorboard_logger.py>`_
-      and `CycleGAN and EfficientNet notebooks <https://github.com/pytorch/ignite/tree/master/examples/notebooks>`_ for detailed usage.
-
-    * See `visdom mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_visdom_logger.py>`_ for detailed usage.
-
-    * See `neptune mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_neptune_logger.py>`_ for detailed usage.
-
-    * See `tqdm mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_tqdm_logger.py>`_ for detailed usage.
-
-    * See `wandb mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_wandb_logger.py>`_ for detailed usage.
-
-    * See `clearml mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_clearml_logger.py>`_ for detailed usage.
+.. deprecated:: 0.4.14
+    Loggers moved to :ref:`Loggers`.
diff --git a/docs/source/handlers.rst b/docs/source/handlers.rst
@@ -1,8 +1,8 @@
 ignite.handlers
 ===============
 
-Complete list of handlers
--------------------------
+Complete list of generic handlers
+----------------------------------
 
 .. currentmodule:: ignite.handlers
 
@@ -33,6 +33,46 @@ Complete list of handlers
     param_scheduler.ParamScheduler
     state_param_scheduler.StateParamScheduler
 
+
+Loggers
+--------
+
+.. currentmodule:: ignite.handlers
+
+.. autosummary::
+    :nosignatures:
+    :toctree: generated
+    :recursive:
+
+    base_logger
+    clearml_logger
+    mlflow_logger
+    neptune_logger
+    polyaxon_logger
+    tensorboard_logger
+    tqdm_logger
+
+    visdom_logger
+    wandb_logger
+
+.. seealso::
+
+    Below are a comprehensive list of examples of various loggers.
+
+    * See `tensorboardX mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_tensorboard_logger.py>`_
+      and `CycleGAN and EfficientNet notebooks <https://github.com/pytorch/ignite/tree/master/examples/notebooks>`_ for detailed usage.
+
+    * See `visdom mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_visdom_logger.py>`_ for detailed usage.
+
+    * See `neptune mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_neptune_logger.py>`_ for detailed usage.
+
+    * See `tqdm mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_tqdm_logger.py>`_ for detailed usage.
+
+    * See `wandb mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_wandb_logger.py>`_ for detailed usage.
+
+    * See `clearml mnist example <https://github.com/pytorch/ignite/blob/master/examples/mnist/mnist_with_clearml_logger.py>`_ for detailed usage.
+
+
 .. _param-scheduler-label:
 
 Parameter scheduler
@@ -396,7 +436,7 @@ Example with :class:`ignite.handlers.param_scheduler.ReduceLROnPlateauScheduler`
     init_lr = 0.1
 
     lr_values = np.array(ReduceLROnPlateauScheduler.simulate_values(
-        num_events, metric_values, init_lr, 
+        num_events, metric_values, init_lr,
         factor=0.5, patience=1, mode='max', threshold=0.01, threshold_mode='abs'
         )
     )

diff --git a/ignite/contrib/engines/common.py b/ignite/contrib/engines/common.py
@@ -15,21 +15,24 @@
     from torch.optim.lr_scheduler import _LRScheduler as PyTorchLRScheduler
 
 import ignite.distributed as idist
-from ignite.contrib.handlers import (
+from ignite.contrib.metrics import GpuInfo
+from ignite.engine import Engine, Events
+from ignite.handlers import (
+    Checkpoint,
     ClearMLLogger,
+    DiskSaver,
+    EarlyStopping,
     global_step_from_engine,
     MLflowLogger,
     NeptuneLogger,
     PolyaxonLogger,
     ProgressBar,
     TensorboardLogger,
+    TerminateOnNan,
     VisdomLogger,
     WandBLogger,
 )
-from ignite.contrib.handlers.base_logger import BaseLogger
-from ignite.contrib.metrics import GpuInfo
-from ignite.engine import Engine, Events
-from ignite.handlers import Checkpoint, DiskSaver, EarlyStopping, TerminateOnNan
+from ignite.handlers.base_logger import BaseLogger
 from ignite.handlers.checkpoint import BaseSaveHandler
 from ignite.handlers.param_scheduler import ParamScheduler
 from ignite.metrics import RunningAverage
@@ -361,7 +364,7 @@ def setup_tb_logging(
         kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        :class:`~ignite.contrib.handlers.tensorboard_logger.TensorboardLogger`
+        :class:`~ignite.handlers.tensorboard_logger.TensorboardLogger`
     """
     logger = TensorboardLogger(log_dir=output_path, **kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -392,7 +395,7 @@ def setup_visdom_logging(
         kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        :class:`~ignite.contrib.handlers.visdom_logger.VisdomLogger`
+        :class:`~ignite.handlers.visdom_logger.VisdomLogger`
     """
     logger = VisdomLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -423,7 +426,7 @@ def setup_mlflow_logging(
         kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        :class:`~ignite.contrib.handlers.mlflow_logger.MLflowLogger`
+        :class:`~ignite.handlers.mlflow_logger.MLflowLogger`
     """
     logger = MLflowLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -454,7 +457,7 @@ def setup_neptune_logging(
         kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        :class:`~ignite.contrib.handlers.neptune_logger.NeptuneLogger`
+        :class:`~ignite.handlers.neptune_logger.NeptuneLogger`
     """
     logger = NeptuneLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -485,7 +488,7 @@ def setup_wandb_logging(
         kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        :class:`~ignite.contrib.handlers.wandb_logger.WandBLogger`
+        :class:`~ignite.handlers.wandb_logger.WandBLogger`
     """
     logger = WandBLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -516,7 +519,7 @@ def setup_plx_logging(
         kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        :class:`~ignite.contrib.handlers.polyaxon_logger.PolyaxonLogger`
+        :class:`~ignite.handlers.polyaxon_logger.PolyaxonLogger`
     """
     logger = PolyaxonLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)
@@ -547,7 +550,7 @@ def setup_clearml_logging(
         kwargs: optional keyword args to be passed to construct the logger.
 
     Returns:
-        :class:`~ignite.contrib.handlers.clearml_logger.ClearMLLogger`
+        :class:`~ignite.handlers.clearml_logger.ClearMLLogger`
     """
     logger = ClearMLLogger(**kwargs)
     _setup_logging(logger, trainer, optimizers, evaluators, log_every_iters)

diff --git a/ignite/contrib/handlers/__init__.py b/ignite/contrib/handlers/__init__.py
@@ -1,14 +1,19 @@
-from ignite.contrib.handlers.clearml_logger import ClearMLLogger
-from ignite.contrib.handlers.mlflow_logger import MLflowLogger
-from ignite.contrib.handlers.neptune_logger import NeptuneLogger
-from ignite.contrib.handlers.polyaxon_logger import PolyaxonLogger
-from ignite.contrib.handlers.tensorboard_logger import TensorboardLogger
-from ignite.contrib.handlers.tqdm_logger import ProgressBar
-
-from ignite.contrib.handlers.visdom_logger import VisdomLogger
-from ignite.contrib.handlers.wandb_logger import WandBLogger
-from ignite.handlers import EpochOutputStore, global_step_from_engine  # ref  # ref
+from ignite.handlers import (  # ref  # ref
+    clearml_logger,
+    EpochOutputStore,
+    global_step_from_engine,
+    mlflow_logger,
+    neptune_logger,
+    polyaxon_logger,
+    tensorboard_logger,
+    tqdm_logger,
+    visdom_logger,
+    wandb_logger,
+)
+from ignite.handlers.clearml_logger import ClearMLLogger
 from ignite.handlers.lr_finder import FastaiLRFinder
+from ignite.handlers.mlflow_logger import MLflowLogger
+from ignite.handlers.neptune_logger import NeptuneLogger
 from ignite.handlers.param_scheduler import (
     ConcatScheduler,
     CosineAnnealingScheduler,
@@ -18,4 +23,10 @@
     ParamGroupScheduler,
     PiecewiseLinear,
 )
+from ignite.handlers.polyaxon_logger import PolyaxonLogger
+from ignite.handlers.tensorboard_logger import TensorboardLogger
 from ignite.handlers.time_profilers import BasicTimeProfiler, HandlersTimeProfiler
+from ignite.handlers.tqdm_logger import ProgressBar
+
+from ignite.handlers.visdom_logger import VisdomLogger
+from ignite.handlers.wandb_logger import WandBLogger