unify warnings

pl_bolts/callbacks/data_monitor.py

@@ -4,15 +4,13 @@
 import numpy as np
 import torch
 import torch.nn as nn
-from torch import Tensor
-from torch.utils.hooks import RemovableHandle
-
 from pytorch_lightning import Callback
 from pytorch_lightning import LightningModule, Trainer
 from pytorch_lightning.loggers import WandbLogger, TensorBoardLogger
 from pytorch_lightning.utilities import rank_zero_warn
 from pytorch_lightning.utilities.apply_func import apply_to_collection
-
+from torch import Tensor
+from torch.utils.hooks import RemovableHandle
 
 try:
     import wandb

pl_bolts/callbacks/ssl_online.py

@@ -1,11 +1,10 @@
-from typing import List, Optional, Union
+from typing import Optional
 
 import torch
+from pytorch_lightning import Callback
 from pytorch_lightning.metrics.functional import accuracy
 from torch.nn import functional as F
 
-from pytorch_lightning import Callback
-
 
 class SSLOnlineEvaluator(Callback):  # pragma: no-cover
     """

pl_bolts/callbacks/variational.py

@@ -1,14 +1,14 @@
 import math
-from warnings import warn
 
 import torch
 from pytorch_lightning.callbacks import Callback
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     import torchvision
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
 
 
 class LatentDimInterpolator(Callback):

pl_bolts/callbacks/vision/image_generation.py

@@ -1,13 +1,12 @@
-from warnings import warn
-
 import torch
 from pytorch_lightning import Callback
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     import torchvision
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
 
 
 class TensorboardGenerativeModelImageSampler(Callback):

pl_bolts/datamodules/binary_mnist_datamodule.py

@@ -1,16 +1,15 @@
-from warnings import warn
-
 import torch
 from pytorch_lightning import LightningDataModule
 from torch.utils.data import DataLoader, random_split
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     from torchvision import transforms as transform_lib
     from torchvision.datasets import MNIST
     from pl_bolts.datasets.mnist_dataset import BinaryMNIST
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datamodules/cifar10_datamodule.py

@@ -1,21 +1,20 @@
 import os
 from typing import Optional, Sequence
-from warnings import warn
 
 import torch
 from pytorch_lightning import LightningDataModule
 from torch.utils.data import DataLoader, random_split
 
 from pl_bolts.datasets.cifar10_dataset import TrialCIFAR10
 from pl_bolts.transforms.dataset_normalizations import cifar10_normalization
+from pl_bolts.utils.warnings import warn_missing_pkg
 
 try:
     from torchvision import transforms as transform_lib
     from torchvision.datasets import CIFAR10
 
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datamodules/cityscapes_datamodule.py

@@ -1,15 +1,13 @@
-from warnings import warn
-
-import torch
 from pytorch_lightning import LightningDataModule
-from torch.utils.data import DataLoader, random_split
+from torch.utils.data import DataLoader
+
+from pl_bolts.utils.warnings import warn_missing_pkg
 
 try:
     from torchvision import transforms as transform_lib
     from torchvision.datasets import Cityscapes
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datamodules/fashion_mnist_datamodule.py

@@ -1,15 +1,14 @@
-from warnings import warn
-
 import torch
 from pytorch_lightning import LightningDataModule
 from torch.utils.data import DataLoader, random_split
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     from torchvision import transforms as transform_lib
     from torchvision.datasets import FashionMNIST
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datamodules/imagenet_datamodule.py

@@ -1,26 +1,24 @@
 import os
 from typing import Optional
-from warnings import warn
 
 from pytorch_lightning import LightningDataModule
 from torch.utils.data import DataLoader
 
 from pl_bolts.transforms.dataset_normalizations import imagenet_normalization
+from pl_bolts.utils.warnings import warn_missing_pkg
 
 try:
     from torchvision import transforms as transform_lib
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True
 
 try:
     from pl_bolts.datasets.imagenet_dataset import UnlabeledImagenet
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datamodules/mnist_datamodule.py

@@ -1,15 +1,14 @@
-from warnings import warn
-
 import torch
 from pytorch_lightning import LightningDataModule
 from torch.utils.data import DataLoader, random_split
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     from torchvision import transforms as transform_lib
     from torchvision.datasets import MNIST
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datamodules/ssl_imagenet_datamodule.py

@@ -1,18 +1,17 @@
 import os
-from warnings import warn
 
 from pytorch_lightning import LightningDataModule
 from torch.utils.data import DataLoader
 
 from pl_bolts.datasets.imagenet_dataset import UnlabeledImagenet
 from pl_bolts.transforms.dataset_normalizations import imagenet_normalization
+from pl_bolts.utils.warnings import warn_missing_pkg
 
 try:
     from torchvision import transforms as transform_lib
 
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datamodules/stl10_datamodule.py

@@ -1,20 +1,19 @@
 import os
 from typing import Optional
-from warnings import warn
 
 import torch
 from pytorch_lightning import LightningDataModule
 from torch.utils.data import DataLoader, random_split
 
 from pl_bolts.datasets.concat_dataset import ConcatDataset
 from pl_bolts.transforms.dataset_normalizations import stl10_normalization
+from pl_bolts.utils.warnings import warn_missing_pkg
 
 try:
     from torchvision import transforms as transform_lib
     from torchvision.datasets import STL10
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datamodules/vocdetection_datamodule.py

@@ -1,16 +1,15 @@
-from warnings import warn
-
 import torch
 import torchvision.transforms as T
 from pytorch_lightning import LightningDataModule
 from torch.utils.data import DataLoader
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     from torchvision.datasets import VOCDetection
 
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
     _TORCHVISION_AVAILABLE = False
 else:
     _TORCHVISION_AVAILABLE = True

pl_bolts/datasets/cifar10_dataset.py

@@ -2,16 +2,16 @@
 import pickle
 import tarfile
 from typing import Tuple, Optional, Sequence, Callable
-from warnings import warn
 
 import torch
 from torch import Tensor
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     from PIL import Image
 except ModuleNotFoundError:
-    warn('You want to use `Pillow` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install Pillow`.')
+    warn_missing_pkg('PIL', pypi_name='Pillow')  # pragma: no-cover
     _PIL_AVAILABLE = False
 else:
     _PIL_AVAILABLE = True

pl_bolts/datasets/mnist_dataset.py

@@ -1,4 +1,4 @@
-from warnings import warn
+from pl_bolts.utils.warnings import warn_missing_pkg
 
 try:
     from torchvision import transforms as transform_lib
@@ -11,8 +11,7 @@
 try:
     from PIL import Image
 except ModuleNotFoundError:
-    warn('You want to use `Pillow` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install Pillow`.')
+    warn_missing_pkg('PIL', pypi_name='Pillow')  # pragma: no-cover
     _PIL_AVAILABLE = False
 else:
     _PIL_AVAILABLE = True

pl_bolts/datasets/ssl_amdim_datasets.py

@@ -1,14 +1,14 @@
 from abc import ABC
 from typing import Callable, Optional
-from warnings import warn
 
 import numpy as np
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     from torchvision.datasets import CIFAR10
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
 
 
 class SSLDatasetMixin(ABC):

pl_bolts/models/detection/faster_rcnn.py

@@ -1,15 +1,15 @@
 from argparse import ArgumentParser
-from warnings import warn
 
 import pytorch_lightning as pl
 import torch
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     from torchvision.models.detection import faster_rcnn, fasterrcnn_resnet50_fpn
     from torchvision.ops import box_iou
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
 
 
 def _evaluate_iou(target, pred):

pl_bolts/models/mnist_module.py

@@ -1,18 +1,18 @@
 import os
 from argparse import ArgumentParser
-from warnings import warn
 
 import torch
 from pytorch_lightning import LightningModule, Trainer
 from torch.nn import functional as F
 from torch.utils.data import DataLoader, random_split
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     from torchvision import transforms
     from torchvision.datasets import MNIST
 except ModuleNotFoundError:
-    warn('You want to use `torchvision` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install torchvision`.')
+    warn_missing_pkg('torchvision')  # pragma: no-cover
 
 
 class LitMNIST(LightningModule):

pl_bolts/models/rl/common/gym_wrappers.py

@@ -3,18 +3,18 @@
 https://github.com/Shmuma/ptan/blob/master/ptan/common/wrappers.py
 """
 import collections
-from warnings import warn
 
 import gym
 import gym.spaces
 import numpy as np
 import torch
 
+from pl_bolts.utils.warnings import warn_missing_pkg
+
 try:
     import cv2
 except ModuleNotFoundError:
-    warn('You want to use `openCV` which is not installed yet,'  # pragma: no-cover
-         ' install it with `pip install opencv-python`.')
+    warn_missing_pkg('cv2', pypi_name='opencv-python')  # pragma: no-cover
     _OPENCV_AVAILABLE = False
 else:
     _OPENCV_AVAILABLE = True