.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/approximators/plot_permutation_sampling_sii.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_permutation_sampling_sii.py>`
        to download the full example code.

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

.. _sphx_glr_auto_examples_approximators_plot_permutation_sampling_sii.py:


PermutationSamplingSII
======================

Permutation-based SII/k-SII approximation using
:class:`~shapiq.PermutationSamplingSII`.

.. 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 k-SII values
------------------------

.. GENERATED FROM PYTHON SOURCE LINES 30-35

.. code-block:: Python


    approximator = shapiq.PermutationSamplingSII(n=N_PLAYERS, max_order=2, random_state=42)
    iv = approximator.approximate(BUDGET, game_fun)
    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=177,
        n_players=8, baseline_value=0.0,
        Top 10 interactions:
            (0,): 0.6499999999999999
            (1,): 0.5500000000000002
            (2,): 0.2
            (3,): 0.10000000000000002
            (4,): 0.04999999999999994
            (4, 5): 2.220446049250313e-16
            (1, 4): -1.249000902703301e-16
            (5,): -0.10000000000000003
            (6,): -0.20000000000000007
            (7,): -0.3
    )




.. 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_permutation_sampling_sii_001.png
   :alt: plot permutation sampling sii
   :srcset: /auto_examples/approximators/images/sphx_glr_plot_permutation_sampling_sii_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 42-44

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

.. GENERATED FROM PYTHON SOURCE LINES 44-46

.. code-block:: Python


    iv.plot_network(feature_names=feature_names)



.. image-sg:: /auto_examples/approximators/images/sphx_glr_plot_permutation_sampling_sii_002.png
   :alt: plot permutation sampling sii
   :srcset: /auto_examples/approximators/images/sphx_glr_plot_permutation_sampling_sii_002.png
   :class: sphx-glr-single-img






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

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


.. _sphx_glr_download_auto_examples_approximators_plot_permutation_sampling_sii.py:

.. only:: html

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

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

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

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

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

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

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