ran black

shapiq/__init__.py

@@ -1,6 +1,7 @@
 """shapiq is a library creating explanations for machine learning models based on
 the well established Shapley value and its generalization to interaction.
 """
+
 from __version__ import __version__
 
 # approximator classes

shapiq/approximator/__init__.py

@@ -1,4 +1,5 @@
 """This module contains the approximators to estimate the Shapley interaction values."""
+
 from .k_sii import convert_ksii_into_one_dimension, transforms_sii_to_ksii
 from .permutation.sii import PermutationSamplingSII
 from .permutation.sti import PermutationSamplingSTI

shapiq/approximator/_base.py

@@ -1,4 +1,5 @@
 """This module contains the base approximator classes for the shapiq package."""
+
 from abc import ABC, abstractmethod
 from typing import Callable, Optional
 

shapiq/approximator/k_sii.py

@@ -1,4 +1,5 @@
 """This module provides the functionality to transform SII values into k-SII values."""
+
 from typing import Optional, Union
 
 import numpy as np

shapiq/approximator/permutation/__init__.py

@@ -1,4 +1,5 @@
 """This module contains all permutation-based sampling algorithms to estimate SII/nSII and STI."""
+
 from .sii import PermutationSamplingSII
 from .sti import PermutationSamplingSTI
 

shapiq/approximator/permutation/sii.py

@@ -1,4 +1,5 @@
 """This module implements the Permutation Sampling approximator for the SII (and k-SII) index."""
+
 from typing import Callable, Optional
 
 import numpy as np

shapiq/approximator/permutation/sti.py

@@ -1,4 +1,5 @@
 """This module contains the permutation sampling algorithms to estimate STI scores."""
+
 import warnings
 from typing import Callable, Optional
 

shapiq/approximator/regression/__init__.py

@@ -1,5 +1,6 @@
 """This module contains the regression-based approximators to estimate Shapley interaction values.
 """
+
 from .fsi import RegressionFSI
 from .sii import RegressionSII
 from .sv import KernelSHAP

shapiq/approximator/regression/_base.py

@@ -1,4 +1,5 @@
 """This module contains the regression algorithms to estimate FSI and SII scores."""
+
 from typing import Callable, Optional
 
 import numpy as np

shapiq/approximator/regression/fsi.py

@@ -1,4 +1,5 @@
 """Regression with Faithful Shapley Interaction (FSI) index approximation."""
+
 from typing import Optional
 
 from ..k_sii import KShapleyMixin

shapiq/approximator/regression/sii.py

@@ -1,4 +1,5 @@
 """Regression with Shapley interaction index (SII) approximation."""
+
 from typing import Optional
 
 from ..k_sii import KShapleyMixin

shapiq/approximator/regression/sv.py

@@ -1,5 +1,6 @@
 """This module contains the KernelSHAP regression approximator for estimating the SV.
 Regression with Faithful Shapley Interaction (FSI) index approximation."""
+
 from typing import Optional
 
 from ._base import Regression

shapiq/approximator/shapiq/shapiq.py

@@ -1,4 +1,5 @@
 """This module contains the shapiq estimator."""
+
 import math
 from typing import Callable, Optional
 

shapiq/datasets/_all.py

@@ -1,4 +1,5 @@
 """This module contains functions to load datasets."""
+
 import os
 
 import pandas as pd

shapiq/explainer/__init__.py

@@ -1,6 +1,5 @@
 """This module contains the explainer for the shapiq package."""
 
-
 from .interaction import InteractionExplainer
 from .tree import TreeExplainer
 

shapiq/explainer/_base.py

@@ -1,4 +1,5 @@
 """This module contains the base explainer classes for the shapiq package."""
+
 from abc import ABC, abstractmethod
 from typing import Callable
 

shapiq/explainer/imputer/_base.py

@@ -1,4 +1,5 @@
 """Base class for imputers."""
+
 from abc import abstractmethod
 from typing import Callable, Optional
 

shapiq/explainer/imputer/marginal_imputer.py

@@ -1,4 +1,5 @@
 """This module contains the marginal imputer for the shapiq package."""
+
 from typing import Callable, Optional
 
 import numpy as np

shapiq/explainer/interaction.py

@@ -1,5 +1,6 @@
 """This module contains the interaction explainer for the shapiq package. This is the main interface
 for users of the shapiq package."""
+
 from typing import Callable, Optional, Union
 
 import numpy as np

shapiq/explainer/tree.py

@@ -1,5 +1,6 @@
 """This module contains the TreeSHAP-IQ explainer for computing exact any order Shapley interactions
 for trees and tree ensembles."""
+
 import numpy as np
 from approximator._interaction_values import InteractionValues
 from explainer._base import Explainer

shapiq/games/__init__.py

@@ -1,4 +1,5 @@
 """This module contains sample game functions for the shapiq package."""
+
 from games.dummy import DummyGame
 
 __all__ = [

shapiq/games/dummy.py

@@ -1,13 +1,13 @@
 """This module contains the DummyGame class. The DummyGame class is mainly used for testing
 purposes. It returns the size of the coalition divided by the number of players plus an additional
 interaction term."""
+
 from typing import Union
 
 import numpy as np
 
 
 class DummyGame:
-
     """Dummy game for testing purposes. When called, it returns the size of the coalition divided by
     the number of players plus an additional interaction term.
 

shapiq/plot/_config.py

@@ -1,4 +1,5 @@
 """This module contains the configuration for the shapiq visualizations."""
+
 from colour import Color
 
 __all__ = [

shapiq/plot/network.py

@@ -1,4 +1,5 @@
 """This module contains the network plots for the shapiq package."""
+
 import copy
 import math
 from typing import Any, Optional, Union

shapiq/plot/stacked_bar.py

@@ -1,4 +1,5 @@
 """This module contains functions to plot the n_sii stacked bar charts."""
+
 __all__ = ["stacked_bar_plot"]
 
 from copy import deepcopy
@@ -124,9 +125,11 @@ def stacked_bar_plot(
 
     # set title and labels if not provided
 
-    axis.set_title(
-        f"n-SII values up to order ${n_sii_max_order}$"
-    ) if title is None else axis.set_title(title)
+    (
+        axis.set_title(f"n-SII values up to order ${n_sii_max_order}$")
+        if title is None
+        else axis.set_title(title)
+    )
 
     axis.set_xlabel("features") if xlabel is None else axis.set_xlabel(xlabel)
     axis.set_ylabel("n-SII values") if ylabel is None else axis.set_ylabel(ylabel)

shapiq/utils/sets.py

@@ -1,4 +1,5 @@
 """This module contains utility functions for dealing with sets, coalitions and game theory."""
+
 import copy
 from collections.abc import Iterable
 from itertools import chain, combinations

tests/tests_approximators/test_approximator_shapiq.py

@@ -1,4 +1,5 @@
 """This test module contains all tests regarding the shapiq approximator."""
+
 from copy import copy, deepcopy
 
 import numpy as np