Put ModuleNotFoundError instead of RuntimeError in proper places (#2750)

* Replaced RuntimeError with ModuleNotFoundError

* Remove DS_Stores

* Replace RuntimeError with ModuleNotFound

in proper places

* Fix tests

* Add test for clearml and a little refactor

* Revert changes for two ipynbs

* Revert changes to two ipynbs

Author: sadra-barikbin

.gitignore

@@ -22,6 +22,7 @@ wheels/
 .installed.cfg
 *.egg
 MANIFEST
+**/.DS_Store
 
 # Unit test / coverage reports
 htmlcov/

examples/gan/dcgan.py

@@ -20,7 +20,7 @@
     import torchvision.utils as vutils
 
 except ImportError:
-    raise ImportError(
+    raise ModuleNotFoundError(
         "Please install torchvision to run this example, for example "
         "via conda by running 'conda install -c pytorch torchvision'. "
     )

examples/mnist/mnist_save_resume_engine.py

@@ -22,7 +22,7 @@
     try:
         from torch.utils.tensorboard import SummaryWriter
     except ImportError:
-        raise RuntimeError(
+        raise ModuleNotFoundError(
             "This module requires either tensorboardX or torch >= 1.2.0. "
             "You may install tensorboardX with command: \n pip install tensorboardX \n"
             "or upgrade PyTorch using your package manager of choice (pip or conda)."

examples/mnist/mnist_with_tensorboard.py

@@ -34,7 +34,7 @@
     try:
         from torch.utils.tensorboard import SummaryWriter
     except ImportError:
-        raise RuntimeError(
+        raise ModuleNotFoundError(
             "This module requires either tensorboardX or torch >= 1.2.0. "
             "You may install tensorboardX with command: \n pip install tensorboardX \n"
             "or upgrade PyTorch using your package manager of choice (pip or conda)."

examples/mnist/mnist_with_tensorboard_on_tpu.py

@@ -31,7 +31,7 @@
 try:
     import torch_xla.core.xla_model as xm
 except ImportError:
-    raise RuntimeError(
+    raise ModuleNotFoundError(
         "In order to run PyTorch on TPU we need to install PyTorch XLA:"
         "\n\t- curl https://raw.githubusercontent.com/pytorch/xla/master/contrib/scripts/env-setup.py -o xla-setup.py"
         "\n\t- python xla-setup.py --version 1.5"

examples/mnist/mnist_with_visdom.py

@@ -15,7 +15,7 @@
 try:
     import visdom
 except ImportError:
-    raise RuntimeError("No visdom package is found. Please install it with command: \n pip install visdom")
+    raise ModuleNotFoundError("No visdom package is found. Please install it with command: \n pip install visdom")
 
 
 class Net(nn.Module):

examples/references/classification/imagenet/code/dataflow/vis.py

@@ -6,7 +6,9 @@
 try:
     from image_dataset_viz import render_datapoint
 except ImportError:
-    raise RuntimeError("Install it via pip install --upgrade git+https://github.com/vfdev-5/ImageDatasetViz.git")
+    raise ModuleNotFoundError(
+        "Please install image-dataset-viz via pip install --upgrade git+https://github.com/vfdev-5/ImageDatasetViz.git"
+    )
 
 
 def tensor_to_numpy(t: torch.Tensor) -> np.ndarray:

examples/references/segmentation/pascal_voc2012/vis.py

@@ -5,7 +5,9 @@
 try:
     from image_dataset_viz import render_datapoint
 except ImportError:
-    raise RuntimeError("Install it via pip install --upgrade git+https://github.com/vfdev-5/ImageDatasetViz.git")
+    raise ModuleNotFoundError(
+        "Please install image-dataset-viz via pip install --upgrade git+https://github.com/vfdev-5/ImageDatasetViz.git"
+    )
 
 
 def _getvocpallete(num_cls):

examples/reinforcement_learning/actor_critic.py

@@ -13,7 +13,7 @@
 try:
     import gym
 except ImportError:
-    raise RuntimeError("Please install opengym: pip install gym")
+    raise ModuleNotFoundError("Please install opengym: pip install gym")
 
 
 SavedAction = namedtuple("SavedAction", ["log_prob", "value"])

examples/reinforcement_learning/reinforce.py

@@ -12,7 +12,7 @@
 try:
     import gym
 except ImportError:
-    raise RuntimeError("Please install opengym: pip install gym")
+    raise ModuleNotFoundError("Please install opengym: pip install gym")
 
 
 class Policy(nn.Module):

ignite/contrib/handlers/clearml_logger.py

@@ -115,7 +115,7 @@ def __init__(self, **kwargs: Any):
             from clearml import Task
             from clearml.binding.frameworks.tensorflow_bind import WeightsGradientHistHelper
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This contrib module requires clearml to be installed. "
                 "You may install clearml using: \n pip install clearml \n"
             )
@@ -842,7 +842,7 @@ def _setup_check_clearml(self, logger: ClearMLLogger, output_uri: str) -> None:
                 # Backwards-compatibility for legacy Trains SDK
                 from trains import Task
             except ImportError:
-                raise RuntimeError(
+                raise ModuleNotFoundError(
                     "This contrib module requires clearml to be installed. "
                     "You may install clearml using: \n pip install clearml \n"
                 )
@@ -917,7 +917,7 @@ def __call__(self, checkpoint: Mapping, filename: str, metadata: Optional[Mappin
                 # Backwards-compatibility for legacy Trains SDK
                 from trains.binding.frameworks import WeightsFileHandler
             except ImportError:
-                raise RuntimeError(
+                raise ModuleNotFoundError(
                     "This contrib module requires clearml to be installed. "
                     "You may install clearml using: \n pip install clearml \n"
                 )

ignite/contrib/handlers/mlflow_logger.py

@@ -88,7 +88,7 @@ def __init__(self, tracking_uri: Optional[str] = None):
         try:
             import mlflow
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This contrib module requires mlflow to be installed. "
                 "Please install it with command: \n pip install mlflow"
             )

ignite/contrib/handlers/neptune_logger.py

@@ -180,7 +180,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         try:
             import neptune
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This contrib module requires neptune-client to be installed. "
                 "You may install neptune with command: \n pip install neptune-client \n"
             )

ignite/contrib/handlers/polyaxon_logger.py

@@ -104,7 +104,7 @@ def __init__(self, *args: Any, **kwargs: Any):
 
                 self.experiment = Experiment(*args, **kwargs)
             except ImportError:
-                raise RuntimeError(
+                raise ModuleNotFoundError(
                     "This contrib module requires polyaxon to be installed.\n"
                     "For Polyaxon v1.x please install it with command: \n pip install polyaxon\n"
                     "For Polyaxon v0.x please install it with command: \n pip install polyaxon-client"

ignite/contrib/handlers/tensorboard_logger.py

@@ -152,7 +152,7 @@ def __init__(self, *args: Any, **kwargs: Any):
             try:
                 from torch.utils.tensorboard import SummaryWriter  # type: ignore[no-redef]
             except ImportError:
-                raise RuntimeError(
+                raise ModuleNotFoundError(
                     "This contrib module requires either tensorboardX or torch >= 1.2.0. "
                     "You may install tensorboardX with command: \n pip install tensorboardX \n"
                     "or upgrade PyTorch using your package manager of choice (pip or conda)."

ignite/contrib/handlers/tqdm_logger.py

@@ -126,7 +126,7 @@ def __init__(
         try:
             from tqdm.autonotebook import tqdm
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This contrib module requires tqdm to be installed. "
                 "Please install it with command: \n pip install tqdm"
             )

ignite/contrib/handlers/visdom_logger.py

@@ -150,7 +150,7 @@ def __init__(
         try:
             import visdom
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This contrib module requires visdom package. "
                 "Please install it with command:\n"
                 "pip install git+https://github.com/fossasia/visdom.git"
@@ -163,7 +163,7 @@ def __init__(
             try:
                 from concurrent.futures import ThreadPoolExecutor
             except ImportError:
-                raise RuntimeError(
+                raise ModuleNotFoundError(
                     "This contrib module requires concurrent.futures module"
                     "Please install it with command:\n"
                     "pip install futures"

ignite/contrib/handlers/wandb_logger.py

@@ -127,7 +127,7 @@ def __init__(self, *args: Any, **kwargs: Any):
 
             self._wandb = wandb
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This contrib module requires wandb to be installed. "
                 "You man install wandb with the command:\n pip install wandb\n"
             )

ignite/contrib/metrics/average_precision.py

@@ -72,7 +72,7 @@ def __init__(
         try:
             from sklearn.metrics import average_precision_score  # noqa: F401
         except ImportError:
-            raise RuntimeError("This contrib module requires sklearn to be installed.")
+            raise ModuleNotFoundError("This contrib module requires scikit-learn to be installed.")
 
         super(AveragePrecision, self).__init__(
             average_precision_compute_fn,

ignite/contrib/metrics/cohen_kappa.py

@@ -59,7 +59,7 @@ def __init__(
         try:
             from sklearn.metrics import cohen_kappa_score  # noqa: F401
         except ImportError:
-            raise RuntimeError("This contrib module requires sklearn to be installed.")
+            raise ModuleNotFoundError("This contrib module requires scikit-learn to be installed.")
         if weights not in (None, "linear", "quadratic"):
             raise ValueError("Kappa Weighting type must be None or linear or quadratic.")
 

ignite/contrib/metrics/gpu_info.py

@@ -37,7 +37,7 @@ def __init__(self) -> None:
         try:
             from pynvml.smi import nvidia_smi
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This contrib module requires pynvml to be installed. "
                 "Please install it with command: \n pip install pynvml"
             )

ignite/contrib/metrics/precision_recall_curve.py

@@ -11,7 +11,7 @@ def precision_recall_curve_compute_fn(y_preds: torch.Tensor, y_targets: torch.Te
     try:
         from sklearn.metrics import precision_recall_curve
     except ImportError:
-        raise RuntimeError("This contrib module requires sklearn to be installed.")
+        raise ModuleNotFoundError("This contrib module requires scikit-learn to be installed.")
 
     y_true = y_targets.cpu().numpy()
     y_pred = y_preds.cpu().numpy()

ignite/contrib/metrics/roc_auc.py

@@ -81,7 +81,7 @@ def __init__(
         try:
             from sklearn.metrics import roc_auc_score  # noqa: F401
         except ImportError:
-            raise RuntimeError("This contrib module requires sklearn to be installed.")
+            raise ModuleNotFoundError("This contrib module requires scikit-learn to be installed.")
 
         super(ROC_AUC, self).__init__(
             roc_auc_compute_fn, output_transform=output_transform, check_compute_fn=check_compute_fn, device=device
@@ -144,7 +144,7 @@ def __init__(self, output_transform: Callable = lambda x: x, check_compute_fn: b
         try:
             from sklearn.metrics import roc_curve  # noqa: F401
         except ImportError:
-            raise RuntimeError("This contrib module requires sklearn to be installed.")
+            raise ModuleNotFoundError("This contrib module requires scikit-learn to be installed.")
 
         super(RocCurve, self).__init__(
             roc_auc_curve_compute_fn, output_transform=output_transform, check_compute_fn=check_compute_fn

ignite/handlers/lr_finder.py

@@ -259,7 +259,7 @@ def plot(
         try:
             from matplotlib import pyplot as plt
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This method requires matplotlib to be installed. "
                 "Please install it with command: \n pip install matplotlib"
             )

ignite/handlers/param_scheduler.py

@@ -132,7 +132,7 @@ def plot_values(cls, num_events: int, **scheduler_kwargs: Mapping) -> Any:
         try:
             import matplotlib.pyplot as plt
         except ImportError:
-            raise RuntimeError(
+            raise ModuleNotFoundError(
                 "This method requires matplotlib to be installed. "
                 "Please install it with command: \n pip install matplotlib"
             )

ignite/handlers/time_profilers.py

@@ -295,7 +295,7 @@ def write_results(self, output_path: str) -> None:
         try:
             import pandas as pd
         except ImportError:
-            raise RuntimeError("Need pandas to write results as files")
+            raise ModuleNotFoundError("Need pandas to write results as files")
 
         iters_per_epoch = self.total_num_iters // self.max_epochs
 
@@ -663,7 +663,7 @@ def write_results(self, output_path: str) -> None:
         try:
             import pandas as pd
         except ImportError:
-            raise RuntimeError("Need pandas to write results as files")
+            raise ModuleNotFoundError("Need pandas to write results as files")
 
         processing_stats = torch.tensor(self.processing_times, dtype=torch.float32)
         dataflow_stats = torch.tensor(self.dataflow_times, dtype=torch.float32)

ignite/metrics/gan/fid.py

@@ -25,12 +25,12 @@ def fid_score(
     try:
         import numpy as np
     except ImportError:
-        raise RuntimeError("fid_score requires numpy to be installed.")
+        raise ModuleNotFoundError("fid_score requires numpy to be installed.")
 
     try:
         import scipy.linalg
     except ImportError:
-        raise RuntimeError("fid_score requires scipy to be installed.")
+        raise ModuleNotFoundError("fid_score requires scipy to be installed.")
 
     mu1, mu2 = mu1.cpu(), mu2.cpu()
     sigma1, sigma2 = sigma1.cpu(), sigma2.cpu()
@@ -175,12 +175,12 @@ def __init__(
         try:
             import numpy as np  # noqa: F401
         except ImportError:
-            raise RuntimeError("This module requires numpy to be installed.")
+            raise ModuleNotFoundError("This module requires numpy to be installed.")
 
         try:
             import scipy  # noqa: F401
         except ImportError:
-            raise RuntimeError("This module requires scipy to be installed.")
+            raise ModuleNotFoundError("This module requires scipy to be installed.")
 
         if num_features is None and feature_extractor is None:
             num_features = 1000

ignite/metrics/gan/utils.py

@@ -22,7 +22,7 @@ def __init__(self, return_features: bool, device: Union[str, torch.device] = "cp
             import torchvision
             from torchvision import models
         except ImportError:
-            raise RuntimeError("This module requires torchvision to be installed.")
+            raise ModuleNotFoundError("This module requires torchvision to be installed.")
         super(InceptionModel, self).__init__()
         self._device = device
         if Version(torchvision.__version__) < Version("0.13.0"):

tests/ignite/contrib/conftest.py

@@ -4,6 +4,25 @@
 import pytest
 
 
+@pytest.fixture
+def no_site_packages(request):
+    import sys
+
+    modules = {}
+    for k in sys.modules:
+        if request.param in k:
+            modules[k] = sys.modules[k]
+    for k in modules:
+        del sys.modules[k]
+
+    prev_path = list(sys.path)
+    sys.path = [p for p in sys.path if "site-packages" not in p]
+    yield "no_site_packages"
+    sys.path = prev_path
+    for k in modules:
+        sys.modules[k] = modules[k]
+
+
 @pytest.fixture()
 def visdom_offline_logfile(dirname):
 

tests/ignite/contrib/handlers/test_clearml_logger.py

@@ -1,7 +1,7 @@
 import math
 import os
 from collections import defaultdict
-from unittest.mock import ANY, call, MagicMock, Mock
+from unittest.mock import ANY, call, MagicMock, Mock, patch
 
 import clearml
 import pytest
@@ -26,6 +26,23 @@
 from ignite.handlers import Checkpoint
 
 
+def test_no_clearml():
+    with patch.dict("sys.modules", {"clearml": None, "trains": None}):
+        with pytest.raises(ModuleNotFoundError, match=r"This contrib module requires clearml to be installed."):
+            ClearMLSaver()
+
+        with pytest.raises(ModuleNotFoundError, match=r"This contrib module requires clearml to be installed."):
+            ClearMLLogger()
+
+    with patch.dict("sys.modules", {"clearml.binding.frameworks.tensorflow_bind": None}):
+        with pytest.raises(ModuleNotFoundError, match=r"This contrib module requires clearml to be installed."):
+            ClearMLLogger()
+
+    with patch.dict("sys.modules", {"clearml.binding.frameworks": None, "trains.binding.frameworks": None}):
+        with pytest.raises(ModuleNotFoundError, match=r"This contrib module requires clearml to be installed."):
+            ClearMLSaver.__call__(None, {}, "")
+
+
 def test_optimizer_params_handler_wrong_setup():
 
     with pytest.raises(TypeError):