Define our own MisconfigurationException

docs/api/datamodules.rst

@@ -141,3 +141,8 @@ NonGeoDataModule
 ^^^^^^^^^^^^^^^^
 
 .. autoclass:: NonGeoDataModule
+
+Utilities
+---------
+
+.. autoclass:: MisconfigurationException

docs/conf.py

@@ -62,7 +62,6 @@
     ("py:class", "LightningDataModule"),
     ("py:class", "pytorch_lightning.core.module.LightningModule"),
     # Undocumented class
-    ("py:exc", "MisconfigurationException"),
     ("py:class", "torchvision.models.resnet.ResNet"),
     ("py:class", "segmentation_models_pytorch.base.model.SegmentationModel"),
 ]

tests/trainers/test_byol.py

@@ -8,14 +8,9 @@
 import torch.nn as nn
 from omegaconf import OmegaConf
 from pytorch_lightning import LightningDataModule, Trainer
-
-# TODO: import from lightning_lite instead
-from pytorch_lightning.utilities.exceptions import (  # type: ignore[attr-defined]
-    MisconfigurationException,
-)
 from torchvision.models import resnet18
 
-from torchgeo.datamodules import ChesapeakeCVPRDataModule
+from torchgeo.datamodules import ChesapeakeCVPRDataModule, MisconfigurationException
 from torchgeo.datasets import ChesapeakeCVPR
 from torchgeo.samplers import GridGeoSampler
 from torchgeo.trainers import BYOLTask

tests/trainers/test_classification.py

@@ -9,16 +9,12 @@
 from _pytest.monkeypatch import MonkeyPatch
 from omegaconf import OmegaConf
 from pytorch_lightning import LightningDataModule, Trainer
-
-# TODO: import from lightning_lite instead
-from pytorch_lightning.utilities.exceptions import (  # type: ignore[attr-defined]
-    MisconfigurationException,
-)
 from torch.nn.modules import Module
 
 from torchgeo.datamodules import (
     BigEarthNetDataModule,
     EuroSATDataModule,
+    MisconfigurationException,
     RESISC45DataModule,
     So2SatDataModule,
     UCMercedDataModule,

tests/trainers/test_detection.py

@@ -9,12 +9,7 @@
 from omegaconf import OmegaConf
 from pytorch_lightning import LightningDataModule, Trainer
 
-# TODO: import from lightning_lite instead
-from pytorch_lightning.utilities.exceptions import (  # type: ignore[attr-defined]
-    MisconfigurationException,
-)
-
-from torchgeo.datamodules import NASAMarineDebrisDataModule
+from torchgeo.datamodules import MisconfigurationException, NASAMarineDebrisDataModule
 from torchgeo.datasets import NASAMarineDebris
 from torchgeo.trainers import ObjectDetectionTask
 

tests/trainers/test_regression.py

@@ -9,12 +9,11 @@
 from omegaconf import OmegaConf
 from pytorch_lightning import LightningDataModule, Trainer
 
-# TODO: import from lightning_lite instead
-from pytorch_lightning.utilities.exceptions import (  # type: ignore[attr-defined]
+from torchgeo.datamodules import (
+    COWCCountingDataModule,
     MisconfigurationException,
+    TropicalCycloneDataModule,
 )
-
-from torchgeo.datamodules import COWCCountingDataModule, TropicalCycloneDataModule
 from torchgeo.datasets import TropicalCyclone
 from torchgeo.trainers import RegressionTask
 

tests/trainers/test_segmentation.py

@@ -9,11 +9,6 @@
 from _pytest.monkeypatch import MonkeyPatch
 from omegaconf import OmegaConf
 from pytorch_lightning import LightningDataModule, Trainer
-
-# TODO: import from lightning_lite instead
-from pytorch_lightning.utilities.exceptions import (  # type: ignore[attr-defined]
-    MisconfigurationException,
-)
 from torch.nn.modules import Module
 
 from torchgeo.datamodules import (
@@ -24,6 +19,7 @@
     InriaAerialImageLabelingDataModule,
     LandCoverAIDataModule,
     LoveDADataModule,
+    MisconfigurationException,
     NAIPChesapeakeDataModule,
     Potsdam2DDataModule,
     SEN12MSDataModule,

torchgeo/datamodules/__init__.py

@@ -26,6 +26,7 @@
 from .spacenet import SpaceNet1DataModule
 from .ucmerced import UCMercedDataModule
 from .usavars import USAVarsDataModule
+from .utils import MisconfigurationException
 from .vaihingen import Vaihingen2DDataModule
 from .xview import XView2DataModule
 
@@ -59,4 +60,6 @@
     # Base classes
     "GeoDataModule",
     "NonGeoDataModule",
+    # Utilities
+    "MisconfigurationException",
 )

torchgeo/datamodules/geo.py

@@ -9,11 +9,6 @@
 import matplotlib.pyplot as plt
 import torch
 from pytorch_lightning import LightningDataModule
-
-# TODO: import from lightning_lite instead
-from pytorch_lightning.utilities.exceptions import (  # type: ignore[attr-defined]
-    MisconfigurationException,
-)
 from torch import Tensor
 from torch.utils.data import DataLoader, Dataset
 
@@ -25,6 +20,7 @@
     RandomBatchGeoSampler,
 )
 from ..transforms import AugmentationSequential
+from .utils import MisconfigurationException
 
 
 class GeoDataModule(LightningDataModule):

torchgeo/datamodules/utils.py

@@ -10,6 +10,11 @@
 from ..datasets import NonGeoDataset
 
 
+# Based on lightning_lite.utilities.exceptions
+class MisconfigurationException(Exception):
+    """Exception used to inform users of misuse with Lightning."""
+
+
 def dataset_split(
     dataset: Union[TensorDataset, NonGeoDataset],
     val_pct: float,