* revert typing changes, update docs

understandable-machine-intelligence-lab · Oct 18, 2023 · f0f90d9 · f0f90d9
1 parent e537708
commit f0f90d9
Show file tree

Hide file tree

Showing 8 changed files with 63 additions and 35 deletions.
diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml
@@ -6,6 +6,9 @@ on:
   pull_request:
   workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   run:

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -4,6 +4,9 @@ on:
   pull_request:
   workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   lint:

diff --git a/docs/Makefile b/docs/Makefile
@@ -12,12 +12,16 @@ BUILDDIR      = build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help Makefile clean
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-rst:
+rst: clean
 	@sphinx-apidoc -o source/docs_api ../quantus --module-first --separate --force
+
+
+clean:
+	rm -rf source/docs_api
diff --git a/docs/source/docs_api/quantus.helpers.enums.rst b/docs/source/docs_api/quantus.helpers.enums.rst
@@ -0,0 +1,7 @@
+quantus.helpers.enums module
+============================
+
+.. automodule:: quantus.helpers.enums
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/docs_api/quantus.helpers.perturbation_utils.rst b/docs/source/docs_api/quantus.helpers.perturbation_utils.rst
@@ -0,0 +1,7 @@
+quantus.helpers.perturbation\_utils module
+==========================================
+
+.. automodule:: quantus.helpers.perturbation_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/docs_api/quantus.helpers.rst b/docs/source/docs_api/quantus.helpers.rst
@@ -22,6 +22,8 @@ Submodules
 
    quantus.helpers.asserts
    quantus.helpers.constants
+   quantus.helpers.enums
+   quantus.helpers.perturbation_utils
    quantus.helpers.plotting
    quantus.helpers.utils
    quantus.helpers.warn
diff --git a/mypy.ini b/mypy.ini
@@ -12,6 +12,7 @@ ignore_missing_imports = True
 no_site_packages = True
 show_none_errors = False
 ignore_errors = False
+plugins = numpy.typing.mypy_plugin
 
 [mypy-quantus.*]
 disallow_untyped_defs = False

diff --git a/quantus/metrics/base.py b/quantus/metrics/base.py
@@ -21,6 +21,7 @@
     Sequence,
     Set,
     TypeVar,
+    Optional,
 )
 
 import matplotlib.pyplot as plt
@@ -73,10 +74,10 @@ def __init__(
         abs: bool,
         normalise: bool,
         normalise_func: Callable,
-        normalise_func_kwargs: Dict[str, ...] | None,
+        normalise_func_kwargs: Optional[Dict[str, Any]],
         return_aggregate: bool,
         aggregate_func: Callable,
-        default_plot_func: Callable[[...], None] | None,
+        default_plot_func: Optional[Callable],
         disable_warnings: bool,
         display_progressbar: bool,
         **kwargs,
@@ -145,15 +146,15 @@ def __call__(
         self,
         model,
         x_batch: np.ndarray,
-        y_batch: np.ndarray | None,
-        a_batch: np.ndarray | None,
-        s_batch: np.ndarray | None,
-        channel_first: bool | None,
-        explain_func: Callable[[...], None] | None,
-        explain_func_kwargs: Dict[str, ...] | None,
-        model_predict_kwargs: Dict[str, ...] | None,
-        softmax: bool | None,
-        device: str | None = None,
+        y_batch: Optional[np.ndarray],
+        a_batch: Optional[np.ndarray],
+        s_batch: Optional[np.ndarray],
+        channel_first: Optional[bool],
+        explain_func: Optional[Callable],
+        explain_func_kwargs: Optional[Dict],
+        model_predict_kwargs: Optional[Dict],
+        softmax: Optional[bool],
+        device: Optional[str] = None,
         batch_size: int = 64,
         custom_batch: Any = None,
         **kwargs,
@@ -301,7 +302,7 @@ def evaluate_batch(
         x_batch: np.ndarray,
         y_batch: np.ndarray,
         a_batch: np.ndarray,
-        s_batch: np.ndarray | None,
+        s_batch: Optional[np.ndarray],
         **kwargs,
     ):
         """
@@ -334,17 +335,17 @@ def general_preprocess(
         self,
         model,
         x_batch: np.ndarray,
-        y_batch: np.ndarray | None,
-        a_batch: np.ndarray | None,
-        s_batch: np.ndarray | None,
-        channel_first: bool | None,
+        y_batch: Optional[np.ndarray],
+        a_batch: Optional[np.ndarray],
+        s_batch: Optional[np.ndarray],
+        channel_first: Optional[bool],
         explain_func: Callable,
-        explain_func_kwargs: Dict[str, ...] | None,
-        model_predict_kwargs: Dict[str, ...] | None,
+        explain_func_kwargs: Optional[Dict[str, Any]],
+        model_predict_kwargs: Optional[Dict[str, Any]],
         softmax: bool,
-        device: str | None,
-        custom_batch: np.ndarray | None,
-    ) -> Dict[str, ...]:
+        device: Optional[str],
+        custom_batch: Optional[np.ndarray],
+    ) -> Dict[str, Any]:
         """
         Prepares all necessary variables for evaluation.
 
@@ -463,11 +464,11 @@ def custom_preprocess(
         self,
         model: ModelInterface,
         x_batch: np.ndarray,
-        y_batch: np.ndarray | None,
-        a_batch: np.ndarray | None,
-        s_batch: np.ndarray | None,
+        y_batch: Optional[np.ndarray],
+        a_batch: Optional[np.ndarray],
+        s_batch: Optional[np.ndarray],
         custom_batch: Any,
-    ) -> Dict[str, ...] | None:
+    ) -> Optional[Dict[str, Any]]:
         """
         Implement this method if you need custom preprocessing of data,
         model alteration or simply for creating/initialising additional
@@ -606,9 +607,9 @@ def custom_postprocess(
         self,
         model: ModelInterface,
         x_batch: np.ndarray,
-        y_batch: np.ndarray | None,
-        a_batch: np.ndarray | None,
-        s_batch: np.ndarray | None,
+        y_batch: Optional[np.ndarray],
+        a_batch: Optional[np.ndarray],
+        s_batch: Optional[np.ndarray],
         **kwargs,
     ):
         """
@@ -712,9 +713,9 @@ def generate_batches(
 
     def plot(
         self,
-        plot_func: Callable[[...], None] | None = None,
+        plot_func: Optional[Callable] = None,
         show: bool = True,
-        path_to_save: str | None = None,
+        path_to_save: Optional[str] = None,
         *args,
         **kwargs,
     ) -> None:
@@ -782,7 +783,7 @@ def get_params(self) -> Dict[str, Any]:
         return {k: v for k, v in self.__dict__.items() if k not in attr_exclude}
 
     @final
-    def batch_preprocess(self, data_batch: Dict[str, ...]) -> Dict[str, ...]:
+    def batch_preprocess(self, data_batch: Dict[str, Any]) -> Dict[str, Any]:
         """
         If `data_batch` has no `a_batch`, will compute explanations.
         This needs to be done on batch level to avoid OOM. Additionally will set `a_axes` property if it is None,
@@ -809,8 +810,8 @@ def batch_preprocess(self, data_batch: Dict[str, ...]) -> Dict[str, ...]:
         return data_batch
 
     def custom_batch_preprocess(
-        self, data_batch: Dict[str, ...]
-    ) -> Dict[str, ...] | None:
+        self, data_batch: Dict[str, Any]
+    ) -> Optional[Dict[str, ...]]:
         """
         Implement this method if you need custom preprocessing of data
         or simply for creating/initialising additional attributes or assertions