.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/approximators/plot_spex.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_approximators_plot_spex.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_approximators_plot_spex.py:


SPEX
====

Sparse Explainer via Fourier transforms using
:class:`~shapiq.SPEX` :footcite:t:`Kang.2025`.

.. GENERATED FROM PYTHON SOURCE LINES 8-27

.. code-block:: Python


    from __future__ import annotations

    import numpy as np

    import shapiq

    N_PLAYERS = 8
    BUDGET = 200
    feature_names = [f"x{i}" for i in range(N_PLAYERS)]

    weights = np.array([0.4, 0.3, 0.2, 0.1, 0.05, -0.1, -0.2, -0.3])


    def game_fun(coalitions: np.ndarray) -> np.ndarray:
        coalitions = np.atleast_2d(coalitions)
        return (coalitions @ weights) + 0.5 * coalitions[:, 0] * coalitions[:, 1]









.. GENERATED FROM PYTHON SOURCE LINES 28-30

Approximate interaction values
------------------------------

.. GENERATED FROM PYTHON SOURCE LINES 30-35

.. code-block:: Python


    approximator = shapiq.SPEX(n=N_PLAYERS, max_order=2, random_state=42)
    iv = approximator.approximate(500, game_fun)  # SPEX requires a larger budget
    print(iv)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    InteractionValues(
        index=k-SII, max_order=2, min_order=0, estimated=True, estimation_budget=384,
        n_players=8, baseline_value=-6.938893903907228e-18,
        Top 10 interactions:
            (np.int64(0), np.int64(1)): 0.5
            (np.int64(2),): 0.20000000000000004
            (np.int64(0),): 0.15000000000000002
            (np.int64(3),): 0.1
            (np.int64(1),): 0.050000000000000044
            (np.int64(4),): 0.049999999999999975
            (): -6.938893903907228e-18
            (np.int64(5),): -0.10000000000000005
            (np.int64(6),): -0.2
            (np.int64(7),): -0.30000000000000004
    )




.. GENERATED FROM PYTHON SOURCE LINES 36-38

Force plot
----------

.. GENERATED FROM PYTHON SOURCE LINES 38-41

.. code-block:: Python


    iv.plot_force(feature_names=feature_names)




.. image-sg:: /auto_examples/approximators/images/sphx_glr_plot_spex_001.png
   :alt: plot spex
   :srcset: /auto_examples/approximators/images/sphx_glr_plot_spex_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 42-44

Network plot
------------

.. GENERATED FROM PYTHON SOURCE LINES 44-47

.. code-block:: Python


    iv.plot_network(feature_names=feature_names)




.. image-sg:: /auto_examples/approximators/images/sphx_glr_plot_spex_002.png
   :alt: plot spex
   :srcset: /auto_examples/approximators/images/sphx_glr_plot_spex_002.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 48-51

References
----------
.. footbibliography::


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 12.629 seconds)


.. _sphx_glr_download_auto_examples_approximators_plot_spex.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_spex.ipynb <plot_spex.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_spex.py <plot_spex.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_spex.zip <plot_spex.zip>`