shapiq 1.2.2__tar.gz → 1.2.3__tar.gz

{shapiq-1.2.2 → shapiq-1.2.3}/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ### Development
 
+### v1.2.3 (2025-03-24)
+- substantially improves the runtime of all `Regression` approximators by a) a faster pre-computation of the regression matrices and b) a faster computation of the weighted least squares regression [#340](https://github.com/mmschlk/shapiq/issues/340)
+- removes `sample_replacements` parameter from `MarginalImputer` and removes the DeprecationWarning for it
+- adds a trivial computation to `TreeSHAP-IQ` for trees that use only one feature in the tree (this works for decision stumps or trees splitting on only one feature multiple times). In such trees, the computation is trivial as the whole effect of $\nu(N) - \nu(\emptyset)$ is all on the main effect of the single feature and there is no interaction effect. This expands on the fix in v1.2.1 [#286](https://github.com/mmschlk/shapiq/issues/286).
+- fixes a bug with xgboost where feature names where trees that did not contain all features would lead `TreeExplainer` to fail
+- fixes a bug with `stacked_bar_plot` where the higher order interactions were inflated by the lower order interactions, thus wrongly showing the higher order interactions as higher than they are
+- fixes a bug where `InteractionValues.get_subset()` returns a faulty `coalition_lookup` dictionary pointing to indices outside the subset of players [#336](https://github.com/mmschlk/shapiq/issues/336)
+- updates default value of `TreeExplainer`'s `min_order` parameter from 1 to 0 to include the baseline value in the interaction values as per default
+- adds the `RegressionFBII` approximator to estimate Faithful Banzhaf interactions via least squares regression [#333](https://github.com/mmschlk/shapiq/pull/333). Additionally, FBII support was introduced in TabularExplainer and MonteCarlo-Approximator.
+- adds a `RandomGame` class as part of `shapiq.games.benchmark` which always returns a random vector of integers between 0 and 100.
+
 ### v1.2.2 (2025-03-11)
 - changes python support to 3.10-3.13 [#318](https://github.com/mmschlk/shapiq/pull/318)
 - fixes a bug that prohibited importing shapiq in environments without write access [#326](https://github.com/mmschlk/shapiq/issues/326)

{shapiq-1.2.2/shapiq.egg-info → shapiq-1.2.3}/PKG-INFO

@@ -1,27 +1,30 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: shapiq
-Version: 1.2.2
+Version: 1.2.3
 Summary: Shapley Interactions for Machine Learning
-Home-page: https://github.com/mmschlk/shapiq
-Author: Maximilian Muschalik et al.
-Author-email: maximilian.muschalik@ifi.lmu.de
-License: MIT
-Project-URL: Tracker, https://github.com/mmschlk/shapiq/issues
-Project-URL: Source, https://github.com/mmschlk/shapiq
-Project-URL: Documentation, https://shapiq.readthedocs.io
+Author: Hubert Baniecki, Fabian Fumagalli
+Author-email: Maximilian Muschalik <Maximilian.Muschalik@lmu.de>
+Maintainer-email: Maximilian Muschalik <Maximilian.Muschalik@lmu.de>
+License-Expression: MIT
+Project-URL: documentation, https://shapiq.readthedocs.io
+Project-URL: source, https://github.com/mmschlk/shapiq
+Project-URL: tracker, https://github.com/mmschlk/shapiq/issues
+Project-URL: changelog, https://github.com/mmschlk/shapiq/blob/main/CHANGELOG.md
 Keywords: python,machine learning,interpretable machine learning,shap,xai,explainable ai,interaction,shapley interactions,shapley values,feature interaction
 Classifier: Development Status :: 4 - Beta
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Programming Language :: Python
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.10.0
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
@@ -31,63 +34,20 @@ Requires-Dist: scikit-learn
 Requires-Dist: tqdm
 Requires-Dist: requests
 Requires-Dist: matplotlib
-Requires-Dist: colour
 Requires-Dist: networkx
-Provides-Extra: docs
-Requires-Dist: numpy; extra == "docs"
-Requires-Dist: scipy; extra == "docs"
-Requires-Dist: pandas; extra == "docs"
-Requires-Dist: scikit-learn; extra == "docs"
-Requires-Dist: tqdm; extra == "docs"
-Requires-Dist: requests; extra == "docs"
-Requires-Dist: matplotlib; extra == "docs"
-Requires-Dist: colour; extra == "docs"
-Requires-Dist: networkx; extra == "docs"
-Requires-Dist: sphinx; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
-Requires-Dist: sphinx_rtd_theme; extra == "docs"
-Requires-Dist: sphinx_toolbox; extra == "docs"
-Requires-Dist: nbsphinx; extra == "docs"
-Requires-Dist: pandoc; extra == "docs"
-Requires-Dist: furo; extra == "docs"
-Requires-Dist: sphinx-copybutton; extra == "docs"
-Requires-Dist: myst-parser; extra == "docs"
-Provides-Extra: dev
-Requires-Dist: numpy; extra == "dev"
-Requires-Dist: scipy; extra == "dev"
-Requires-Dist: pandas; extra == "dev"
-Requires-Dist: scikit-learn; extra == "dev"
-Requires-Dist: tqdm; extra == "dev"
-Requires-Dist: requests; extra == "dev"
-Requires-Dist: matplotlib; extra == "dev"
-Requires-Dist: colour; extra == "dev"
-Requires-Dist: networkx; extra == "dev"
-Requires-Dist: sphinx; extra == "dev"
-Requires-Dist: sphinx-autodoc-typehints; extra == "dev"
-Requires-Dist: sphinx_rtd_theme; extra == "dev"
-Requires-Dist: sphinx_toolbox; extra == "dev"
-Requires-Dist: nbsphinx; extra == "dev"
-Requires-Dist: pandoc; extra == "dev"
-Requires-Dist: furo; extra == "dev"
-Requires-Dist: sphinx-copybutton; extra == "dev"
-Requires-Dist: myst-parser; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: coverage; extra == "dev"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+Requires-Dist: colour
+Provides-Extra: ml
+Requires-Dist: tabpfn; extra == "ml"
+Requires-Dist: torchvision; extra == "ml"
+Requires-Dist: torch; extra == "ml"
+Requires-Dist: xgboost; extra == "ml"
+Requires-Dist: lightgbm; extra == "ml"
+Requires-Dist: transformers; extra == "ml"
+Requires-Dist: scikit-image; extra == "ml"
+Requires-Dist: joblib; extra == "ml"
+Requires-Dist: tensorflow; python_version < "3.13" and extra == "ml"
+Requires-Dist: tf-keras; python_version < "3.13" and extra == "ml"
+Dynamic: license-file
 
 # shapiq: Shapley Interactions for Machine Learning <img src="https://raw.githubusercontent.com/mmschlk/shapiq/main/docs/source/_static/logo/logo_shapiq_light.svg" alt="shapiq_logo" align="right" height="250px"/>
 
@@ -102,6 +62,8 @@ Dynamic: summary
 [![PePy](https://static.pepy.tech/badge/shapiq?style=flat-square)](https://pepy.tech/project/shapiq)
 
 [![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen)
+![Last Commit](https://img.shields.io/github/last-commit/mmschlk/shapiq)
 
 > An interaction may speak more than a thousand main effects.
 
@@ -279,11 +241,21 @@ Some authors acknowledge the financial support by the German Research Foundation
 ---
 Built with ❤️ by the shapiq team.
 
-
 ## Changelog
 
 ### Development
 
+### v1.2.3 (2025-03-24)
+- substantially improves the runtime of all `Regression` approximators by a) a faster pre-computation of the regression matrices and b) a faster computation of the weighted least squares regression [#340](https://github.com/mmschlk/shapiq/issues/340)
+- removes `sample_replacements` parameter from `MarginalImputer` and removes the DeprecationWarning for it
+- adds a trivial computation to `TreeSHAP-IQ` for trees that use only one feature in the tree (this works for decision stumps or trees splitting on only one feature multiple times). In such trees, the computation is trivial as the whole effect of $\nu(N) - \nu(\emptyset)$ is all on the main effect of the single feature and there is no interaction effect. This expands on the fix in v1.2.1 [#286](https://github.com/mmschlk/shapiq/issues/286).
+- fixes a bug with xgboost where feature names where trees that did not contain all features would lead `TreeExplainer` to fail
+- fixes a bug with `stacked_bar_plot` where the higher order interactions were inflated by the lower order interactions, thus wrongly showing the higher order interactions as higher than they are
+- fixes a bug where `InteractionValues.get_subset()` returns a faulty `coalition_lookup` dictionary pointing to indices outside the subset of players [#336](https://github.com/mmschlk/shapiq/issues/336)
+- updates default value of `TreeExplainer`'s `min_order` parameter from 1 to 0 to include the baseline value in the interaction values as per default
+- adds the `RegressionFBII` approximator to estimate Faithful Banzhaf interactions via least squares regression [#333](https://github.com/mmschlk/shapiq/pull/333). Additionally, FBII support was introduced in TabularExplainer and MonteCarlo-Approximator.
+- adds a `RandomGame` class as part of `shapiq.games.benchmark` which always returns a random vector of integers between 0 and 100.
+
 ### v1.2.2 (2025-03-11)
 - changes python support to 3.10-3.13 [#318](https://github.com/mmschlk/shapiq/pull/318)
 - fixes a bug that prohibited importing shapiq in environments without write access [#326](https://github.com/mmschlk/shapiq/issues/326)

{shapiq-1.2.2 → shapiq-1.2.3}/README.md

@@ -11,6 +11,8 @@
 [![PePy](https://static.pepy.tech/badge/shapiq?style=flat-square)](https://pepy.tech/project/shapiq)
 
 [![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen)
+![Last Commit](https://img.shields.io/github/last-commit/mmschlk/shapiq)
 
 > An interaction may speak more than a thousand main effects.
 

shapiq-1.2.3/pyproject.toml

@@ -0,0 +1,121 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "shapiq"
+dynamic = ["version", "readme"]
+description = "Shapley Interactions for Machine Learning"
+requires-python = ">=3.10"
+dependencies = [
+    # core
+    "numpy",
+    "scipy",
+    "pandas",
+    "scikit-learn",
+    "tqdm",
+    "requests",
+    # plotting
+    "matplotlib",
+    "networkx",
+    "colour"
+]
+authors = [
+    {name = "Maximilian Muschalik", email = "Maximilian.Muschalik@lmu.de"},
+    {name = "Hubert Baniecki"},
+    {name = "Fabian Fumagalli"},
+]
+maintainers = [
+    {name = "Maximilian Muschalik", email = "Maximilian.Muschalik@lmu.de"},
+]
+license = "MIT"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    'Operating System :: Microsoft :: Windows',
+    'Operating System :: Unix',
+    'Operating System :: MacOS',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
+]
+keywords = [
+    "python",
+    "machine learning",
+    "interpretable machine learning",
+    "shap",
+    "xai",
+    "explainable ai",
+    "interaction",
+    "shapley interactions",
+    "shapley values",
+    "feature interaction",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["shapiq*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "shapiq.__version__"}
+readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"}
+
+[project.urls]
+documentation = "https://shapiq.readthedocs.io"
+source = "https://github.com/mmschlk/shapiq"
+tracker = "https://github.com/mmschlk/shapiq/issues"
+changelog = "https://github.com/mmschlk/shapiq/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+ml = [
+    "tabpfn",
+    "torchvision",
+    "torch",
+    "xgboost",
+    "lightgbm",
+    "transformers",
+    "scikit-image",
+    "joblib",
+    "tensorflow; python_version < '3.13'",
+    "tf-keras; python_version < '3.13'",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+minversion = "8.0"
+
+[tool.ruff]
+lint.select = ["E", "F", "I", "UP"]  # https://beta.ruff.rs/docs/rules/
+lint.ignore = ["E501"]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint.isort]
+known-first-party = ["shapiq"]
+extra-standard-library = ["typing_extensions"]
+combine-as-imports = true
+force-wrap-aliases = true
+
+[dependency-groups]
+test = [
+    "pytest>=8.3.5",
+    "pytest-cov>=6.0.0",
+    "pytest-xdist>=3.6.1",
+]
+lint = [
+    "ruff>=0.11.2",
+    "pre-commit>=4.2.0",
+]
+dev = [
+    "build>=1.2.2.post1",
+    "twine>=6.1.0",
+    "notebook>=7.3.3",
+    "ipywidgets",
+    {include-group = "test"},
+    {include-group = "lint"},
+]

{shapiq-1.2.2 → shapiq-1.2.3}/shapiq/__init__.py

@@ -2,7 +2,7 @@
 the well established Shapley value and its generalization to interaction.
 """
 
-__version__ = "1.2.2"
+__version__ = "1.2.3"
 
 # approximator classes
 from .approximator import (
@@ -16,6 +16,7 @@ from .approximator import (
     PermutationSamplingSII,
     PermutationSamplingSTII,
     PermutationSamplingSV,
+    RegressionFBII,
     RegressionFSII,
     StratifiedSamplingSV,
     UnbiasedKernelSHAP,
@@ -86,6 +87,7 @@ __all__ = [
     "OwenSamplingSV",
     "KernelSHAP",
     "RegressionFSII",
+    "RegressionFBII",
     "KernelSHAPIQ",
     "InconsistentKernelSHAPIQ",
     "SHAPIQ",

{shapiq-1.2.2 → shapiq-1.2.3}/shapiq/approximator/__init__.py

@@ -6,7 +6,14 @@ from .montecarlo import SHAPIQ, SVARM, SVARMIQ, UnbiasedKernelSHAP
 from .permutation.sii import PermutationSamplingSII
 from .permutation.stii import PermutationSamplingSTII
 from .permutation.sv import PermutationSamplingSV
-from .regression import InconsistentKernelSHAPIQ, KernelSHAP, KernelSHAPIQ, RegressionFSII, kADDSHAP
+from .regression import (
+    InconsistentKernelSHAPIQ,
+    KernelSHAP,
+    KernelSHAPIQ,
+    RegressionFBII,
+    RegressionFSII,
+    kADDSHAP,
+)
 
 # contains all SV approximators
 SV_APPROXIMATORS: list[Approximator.__class__] = [
@@ -57,6 +64,11 @@ FSII_APPROXIMATORS: list[Approximator.__class__] = [
     SHAPIQ,
 ]
 
+# contains all approximators that can be used for FBII
+FBII_APPROXIMATORS: list[Approximator.__class__] = [
+    RegressionFBII,
+]
+
 __all__ = [
     "PermutationSamplingSII",
     "PermutationSamplingSTII",
@@ -65,6 +77,7 @@ __all__ = [
     "OwenSamplingSV",
     "KernelSHAP",
     "RegressionFSII",
+    "RegressionFBII",
     "KernelSHAPIQ",
     "InconsistentKernelSHAPIQ",
     "SHAPIQ",
@@ -77,6 +90,7 @@ __all__ = [
     "SII_APPROXIMATORS",
     "STII_APPROXIMATORS",
     "FSII_APPROXIMATORS",
+    "FBII_APPROXIMATORS",
 ]
 
 # Path: shapiq/approximator/__init__.py

{shapiq-1.2.2 → shapiq-1.2.3}/shapiq/approximator/_base.py

@@ -1,17 +1,16 @@
 """This module contains the base approximator classes for the shapiq package."""
 
-import copy
+import warnings
 from abc import ABC, abstractmethod
 from collections.abc import Callable
 
 import numpy as np
+from scipy.special import binom
 
 from ..approximator.sampling import CoalitionSampler
 from ..game_theory.indices import (
     AVAILABLE_INDICES_FOR_APPROXIMATION,
     get_computation_index,
-    is_empty_value_the_baseline,
-    is_index_aggregated,
 )
 from ..interaction_values import InteractionValues
 from ..utils.sets import generate_interaction_lookup
@@ -110,7 +109,7 @@ class Approximator(ABC):
         self, budget: int, game: Callable[[np.ndarray], np.ndarray], *args, **kwargs
     ) -> InteractionValues:
         """Calls the approximate method."""
-        return self.approximate(budget, game, *args, **kwargs)
+        return self.approximate(budget=budget, game=game, *args, **kwargs)
 
     @abstractmethod
     def approximate(
@@ -129,7 +128,9 @@ class Approximator(ABC):
         Raises:
             NotImplementedError: If the method is not implemented.
         """
-        raise NotImplementedError("The approximate method needs to be implemented.")
+        raise NotImplementedError(
+            "The approximate method must be implemented in the subclass."
+        )  # pragma: no cover
 
     def _init_sampling_weights(self) -> np.ndarray:
         """Initializes the weights for sampling subsets.
@@ -141,13 +142,29 @@ class Approximator(ABC):
             The weights for sampling subsets of size ``s`` in shape ``(n + 1,)``.
         """
         weight_vector = np.zeros(shape=self.n + 1)
-        for coalition_size in range(0, self.n + 1):
-            if (coalition_size < self.max_order) or (coalition_size > self.n - self.max_order):
-                # prioritize these subsets
-                weight_vector[coalition_size] = self._big_M
-            else:
-                # KernelSHAP sampling weights
-                weight_vector[coalition_size] = 1 / (coalition_size * (self.n - coalition_size))
+        if self.index in ["FBII"]:
+
+            try:
+                for coalition_size in range(0, self.n + 1):
+                    weight_vector[coalition_size] = binom(self.n, coalition_size) / 2**self.n
+            except OverflowError:
+                for coalition_size in range(0, self.n + 1):
+                    weight_vector[coalition_size] = (
+                        1
+                        / np.sqrt(2 * np.pi * 0.5)
+                        * np.exp(-(coalition_size - self.n / 2) * +2 / (self.n / 2))
+                    )
+                warnings.warn(
+                    "The weights are approximated for n > 1000. While this is very close to the truth for sets for size in the region n/2, the approximation is not exact for size n or 0."
+                )
+        else:
+            for coalition_size in range(0, self.n + 1):
+                if (coalition_size < self.max_order) or (coalition_size > self.n - self.max_order):
+                    # prioritize these subsets
+                    weight_vector[coalition_size] = self._big_M
+                else:
+                    # KernelSHAP sampling weights
+                    weight_vector[coalition_size] = 1 / (coalition_size * (self.n - coalition_size))
         sampling_weight = weight_vector / np.sum(weight_vector)
         return sampling_weight
 
@@ -173,65 +190,6 @@ class Approximator(ABC):
         """
         return range(self.min_order, self.max_order + 1)
 
-    def _finalize_result(
-        self,
-        result,
-        baseline_value: float,
-        *,
-        estimated: bool | None = None,
-        budget: int | None = None,
-    ) -> InteractionValues:
-        """Finalizes the result dictionary.
-
-        Args:
-            result: Interaction values.
-            baseline_value: Baseline value.
-            estimated: Whether interaction values were estimated.
-            budget: The budget for the approximation.
-
-        Returns:
-            The interaction values.
-
-        Raises:
-            ValueError: If the baseline value is not provided for SII and k-SII.
-        """
-
-        if budget is None:  # try to get budget from sampler
-            budget = self._sampler.n_coalitions
-            if budget == 0:
-                raise ValueError("Budget is 0. Cannot finalize interaction values.")
-                # Note to developer: This should not happen, the finalize method should be called
-                # with a valid budget.
-
-        if estimated is None:
-            estimated = False if budget >= 2**self.n else True
-
-        # set empty value as baseline value if necessary
-        if tuple() in self._interaction_lookup:
-            idx = self._interaction_lookup[tuple()]
-            empty_value = result[idx]
-            # only for SII empty value is not the baseline value
-            if empty_value != baseline_value and is_empty_value_the_baseline(self.index):
-                result[idx] = baseline_value
-
-        interactions = InteractionValues(
-            values=result,
-            estimated=estimated,
-            estimation_budget=budget,
-            index=self.approximation_index,  # can be different from self.index
-            min_order=self.min_order,
-            max_order=self.max_order,
-            n_players=self.n,
-            interaction_lookup=copy.deepcopy(self.interaction_lookup),
-            baseline_value=baseline_value,
-        )
-
-        # if index needs to be aggregated
-        if is_index_aggregated(self.index):
-            interactions = self.aggregate_interaction_values(interactions)
-
-        return interactions
-
     @staticmethod
     def _calc_iteration_count(budget: int, batch_size: int, iteration_cost: int) -> tuple[int, int]:
         """Computes the number of iterations and the size of the last batch given the batch size and
@@ -304,7 +262,6 @@ class Approximator(ABC):
     def aggregate_interaction_values(
         base_interactions: InteractionValues,
         order: int | None = None,
-        player_set: set[int] | None = None,
     ) -> InteractionValues:
         """Aggregates the interaction values.
 
@@ -312,33 +269,10 @@ class Approximator(ABC):
             base_interactions: The base interaction values to aggregate.
             order: The order of the aggregation. For example, the order of the k-SII aggregation.
                 If ``None`` (default), the maximum order of the base interactions is used.
-            player_set: The set of players to consider for the aggregation. If ``None`` (default),
-                all players are considered.
 
         Returns:
             The aggregated interaction values.
         """
-        from shapiq.game_theory.aggregation import aggregate_interaction_values
-
-        if player_set is not None:
-            raise NotImplementedError(
-                "Aggregating interaction values for a subset of players is not implemented."
-            )
-
-        return aggregate_interaction_values(base_interactions, order=order)
-
-    @staticmethod
-    def aggregate_to_one_dimension(
-        interaction_values: InteractionValues,
-    ) -> tuple[np.ndarray, np.ndarray]:
-        """Aggregates the interaction values to one dimension.
-
-        Args:
-            interaction_values: The interaction values to aggregate.
-
-        Returns:
-            tuple[np.ndarray, np.ndarray]: The positive and negative aggregated values.
-        """
-        from shapiq.game_theory.aggregation import aggregate_to_one_dimension
+        from shapiq.game_theory.aggregation import aggregate_base_interaction
 
-        return aggregate_to_one_dimension(interaction_values)
+        return aggregate_base_interaction(base_interactions, order=order)

{shapiq-1.2.2 → shapiq-1.2.3}/shapiq/approximator/marginals/owen.py

@@ -6,7 +6,7 @@ from collections.abc import Callable
 
 import numpy as np
 
-from ...interaction_values import InteractionValues
+from ...interaction_values import InteractionValues, finalize_computed_interactions
 from .._base import Approximator
 
 
@@ -41,13 +41,14 @@ class OwenSamplingSV(Approximator):
         self.n_anchor_points = n_anchor_points
 
     def approximate(
-        self, budget: int, game: Callable[[np.ndarray], np.ndarray]
+        self, budget: int, game: Callable[[np.ndarray], np.ndarray], *args, **kwargs
     ) -> InteractionValues:
         """Approximates the Shapley values using Owen Sampling.
 
         Args:
             budget: The number of game evaluations for approximation
             game: The game function as a callable that takes a set of players and returns the value.
+            args and kwargs: Additional arguments and keyword arguments not used in this method.
 
         Returns:
             The estimated interaction values.
@@ -100,16 +101,39 @@ class OwenSamplingSV(Approximator):
             idx = self._interaction_lookup[(player,)]
             result_to_finalize[idx] = result[player]
 
-        return self._finalize_result(
-            result_to_finalize, baseline_value=empty_value, budget=used_budget, estimated=True
+        interaction = InteractionValues(
+            n_players=self.n,
+            values=result_to_finalize,
+            index=self.approximation_index,
+            interaction_lookup=self._interaction_lookup,
+            baseline_value=empty_value,
+            min_order=self.min_order,
+            max_order=self.max_order,
+            estimated=True,
+            estimation_budget=used_budget,
+        )
+
+        return finalize_computed_interactions(
+            interaction,
+            target_index=self.index,
         )
 
     @staticmethod
-    def get_anchor_points(m: int):
-        if m <= 0:
-            raise ValueError("The number of anchor points needs to be greater than 0.")
+    def get_anchor_points(n_anchor_points: int):
+        """Returns the anchor points for the Owen Sampling approximation.
+
+        Args:
+            n_anchor_points: The number of anchor points.
 
-        if m == 1:
+        Returns:
+            An array of anchor points.
+
+        Raises:
+            ValueError: If the number of anchor points is less than or equal to 0.
+        """
+        if n_anchor_points <= 0:
+            raise ValueError("The number of anchor points needs to be greater than 0.")
+        elif n_anchor_points == 1:
             return np.array([0.5])
         else:
-            return np.linspace(0.0, 1.0, num=m)
+            return np.linspace(0.0, 1.0, num=n_anchor_points)

{shapiq-1.2.2 → shapiq-1.2.3}/shapiq/approximator/marginals/stratified.py

@@ -4,7 +4,7 @@ from collections.abc import Callable
 
 import numpy as np
 
-from ...interaction_values import InteractionValues
+from ...interaction_values import InteractionValues, finalize_computed_interactions
 from .._base import Approximator
 
 
@@ -37,13 +37,14 @@ class StratifiedSamplingSV(Approximator):
         self.iteration_cost: int = 2
 
     def approximate(
-        self, budget: int, game: Callable[[np.ndarray], np.ndarray]
+        self, budget: int, game: Callable[[np.ndarray], np.ndarray], *args, **kwargs
     ) -> InteractionValues:
         """Approximates the Shapley values using ApproShapley.
 
         Args:
             budget: The number of game evaluations for approximation
             game: The game function as a callable that takes a set of players and returns the value.
+            *args and **kwargs: Additional arguments not used.
 
         Returns:
             The estimated interaction values.
@@ -114,6 +115,16 @@ class StratifiedSamplingSV(Approximator):
             idx = self._interaction_lookup[(player,)]
             result_to_finalize[idx] = result[player]
 
-        return self._finalize_result(
-            result_to_finalize, baseline_value=empty_value, budget=used_budget, estimated=True
+        interactions = InteractionValues(
+            n_players=self.n,
+            values=result_to_finalize,
+            index=self.approximation_index,
+            interaction_lookup=self._interaction_lookup,
+            baseline_value=float(empty_value),
+            min_order=self.min_order,
+            max_order=self.max_order,
+            estimated=True,
+            estimation_budget=used_budget,
         )
+
+        return finalize_computed_interactions(interactions, target_index=self.index)