Merge pull request #210 from ENSTA-U2IS-AI/dev

🐛 Fix unprotected optional dependency

Author: alafage

.github/workflows/run-tests.yml

@@ -69,7 +69,7 @@ jobs:
     - name: Check that torch-uncertainty can be imported
       if: steps.changed-files-specific.outputs.only_changed != 'true'
       run: |
-        python3 -c "import torch_uncertainty as tu"
+        python3 -c "import torch_uncertainty; from torch_uncertainty.datamodules import MNISTDataModule"
       
     - name: Install the optional dependencies
       if: steps.changed-files-specific.outputs.only_changed != 'true'

docs/source/conf.py

@@ -20,7 +20,7 @@
     f"{datetime.now().year!s}, Adrien Lafage and Olivier Laurent"
 )
 author = "Adrien Lafage and Olivier Laurent"
-release = "0.7.0"
+release = "0.7.0.post1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "torch_uncertainty"
-version = "0.7.0"
+version = "0.7.0.post1"
 authors = [
     { name = "ENSTA U2IS AI", email = "[email protected]" },
     { name = "Adrien Lafage", email = "[email protected]" },

torch_uncertainty/datasets/classification/ucr_uea.py

@@ -1,11 +1,18 @@
 import warnings
 from collections.abc import Callable
+from importlib import util
 
 import numpy as np
 import torch
 from einops import rearrange
 from torch.utils.data import Dataset
-from tslearn.datasets import UCR_UEA_datasets
+
+if util.find_spec("tslearn"):
+    from tslearn.datasets import UCR_UEA_datasets
+
+    tslearn_installed = True
+else:  # coverage: ignore
+    tslearn_installed = False
 
 
 class UCRUEADataset(Dataset):
@@ -32,6 +39,13 @@ def __init__(
         Raises:
             ValueError: If `split` is set to "ood" but `create_ood` is not set to True.
         """
+        if not tslearn_installed:  # coverage: ignore
+            raise ImportError(
+                "The tslearn library is not installed. Please install "
+                "torch_uncertainty with the timeseries option: "
+                """pip install -U "torch_uncertainty[timeseries]"."""
+            )
+
         if split == "ood" and not create_ood:
             raise ValueError(
                 "Cannot use split 'ood' without setting create_ood to True. "