Merge pull request #70 from UnravelSports/feat/docs

docs + test fix

Author: UnravelSports

.readthedocs.yaml

@@ -18,13 +18,9 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
-  jobs:
-    post_install:
-      # Install package dependencies
-      - pip install -e .
 
 python:
   install:
-    - requirements: docs/requirements.txt
     - method: pip
       path: .
+    - requirements: docs/requirements.txt

docs/source/conf.py

@@ -60,6 +60,17 @@
 autodoc_typehints = "description"
 autodoc_class_signature = "separated"
 
+# Mock imports for heavy dependencies that aren't needed for building docs
+autodoc_mock_imports = [
+    "torch",
+    "torch_geometric",
+    "pytorch_lightning",
+    "torchmetrics",
+    "tensorflow",
+    "keras",
+    "spektral",
+]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

tests/test_soccer.py

@@ -1586,9 +1586,10 @@ def test_efpi_period_442(self, kloppy_polars_sportec_dataset: KloppyPolarsDatase
 
     def test_efpi_wrong(self, kloppy_polars_sportec_dataset):
         import pytest
-        from polars.exceptions import PanicException
 
-        with pytest.raises(pl.exceptions.InvalidOperationError):
+        with pytest.raises(
+            (pl.exceptions.PanicException, pl.exceptions.InvalidOperationError)
+        ):
             model = EFPI(dataset=kloppy_polars_sportec_dataset)
             model.fit(
                 formations=["442"],

unravel/classifiers/__init__.py

@@ -14,6 +14,17 @@ def __init__(self, *args, **kwargs):
     __all__ = ["CrystalGraphClassifier"]
 
 
-from .crystal_graph_pyg import PyGLightningCrystalGraphClassifier
+try:
+    from .crystal_graph_pyg import PyGLightningCrystalGraphClassifier
+
+    __all__.append("PyGLightningCrystalGraphClassifier")
+except ImportError:
+
+    class PyGLightningCrystalGraphClassifier:
+        def __init__(self, *args, **kwargs):
+            raise ImportError(
+                "PyGLightningCrystalGraphClassifier requires PyTorch and PyTorch Geometric. "
+                "Install with: pip install torch torch-geometric pytorch-lightning torchmetrics"
+            )
 
-__all__.append("PyGLightningCrystalGraphClassifier")
+    __all__.append("PyGLightningCrystalGraphClassifier")