Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
shapiq 1.5.1.dev1+g756a2e646 documentation
Light Logo Dark Logo

INTRODUCTION

  • What Are Shapley Interactions, and Why Should You Care?
  • Installation
  • Getting Started
  • Why Use shapiq?

EXAMPLES & TUTORIALS

  • Examples & Tutorials
  • Approximators
  • Basics
  • Game Theoretic Concepts
  • Language Models
  • Nearest Neighbor Models
  • Tabular Models
  • Tree Models
  • Vision Models
  • Visualization
    • Approximators
      • SVARM
      • KernelSHAP
      • OwenSamplingSV
      • UnbiasedKernelSHAP
      • StratifiedSamplingSV
      • PermutationSamplingSV
      • kADDSHAP
      • ProxySPEX
      • KernelSHAPIQ
      • RegressionFBII
      • RegressionFSII
      • PermutationSamplingSII
      • SHAPIQ Approximator
      • PermutationSamplingSTII
      • SVARMIQ
      • InconsistentKernelSHAPIQ
      • ProxySHAP
      • SPEX
      • RegressionMSR
      • ExactComputer
    • Basics
      • Parallel Computation with joblib
      • Defining Custom Games
      • Computing Shapley Values
    • Game Theoretic Concepts
      • The Core: A Different View on Explanation
    • Language Models
      • Explaining Sentiment Analysis
    • Nearest Neighbor Models
      • Data Valuation with Nearest Neighbor Explainers
    • Tabular Models
      • Conditional Data Imputation
      • SHAP-IQ with scikit-learn
      • Explaining TabPFN
    • Tree Models
      • TreeSHAP-IQ for Custom Tree Models
      • TreeSHAP-IQ for LightGBM
    • Vision Models
      • Explaining a Vision Transformer
    • Visualization
      • Computing Shapley Values.
      • UpSet Plot
      • SI Graph Plot
      • Visualization Catalog
      • Working with InteractionValues
      • Beeswarm Plot
      • Scatter Plot

API REFERENCE

  • API Reference
    • shapiq.interaction_values
      • shapiq.interaction_values.InteractionValues
      • shapiq.interaction_values.aggregate_interaction_values
    • shapiq.game
      • shapiq.game.Game
    • shapiq.explainer
      • shapiq.explainer.Explainer
      • shapiq.explainer.TabularExplainer
      • shapiq.explainer.TabPFNExplainer
      • shapiq.explainer.AgnosticExplainer
      • shapiq.explainer.TreeExplainer
    • shapiq.approximator
      • shapiq.approximator.Approximator
      • shapiq.approximator.PermutationSamplingSII
      • shapiq.approximator.PermutationSamplingSTII
      • shapiq.approximator.PermutationSamplingSV
      • shapiq.approximator.StratifiedSamplingSV
      • shapiq.approximator.OwenSamplingSV
      • shapiq.approximator.KernelSHAP
      • shapiq.approximator.RegressionFSII
      • shapiq.approximator.RegressionFBII
      • shapiq.approximator.KernelSHAPIQ
      • shapiq.approximator.InconsistentKernelSHAPIQ
      • shapiq.approximator.ProxySPEX
      • shapiq.approximator.ProxySHAP
      • shapiq.approximator.RegressionMSR
      • shapiq.approximator.SHAPIQ
      • shapiq.approximator.SVARM
      • shapiq.approximator.SVARMIQ
      • shapiq.approximator.kADDSHAP
      • shapiq.approximator.SPEX
      • shapiq.approximator.UnbiasedKernelSHAP
    • shapiq.imputer
      • shapiq.imputer.Imputer
      • shapiq.imputer.MarginalImputer
      • shapiq.imputer.GenerativeConditionalImputer
      • shapiq.imputer.BaselineImputer
      • shapiq.imputer.TabPFNImputer
      • shapiq.imputer.GaussianImputer
      • shapiq.imputer.GaussianCopulaImputer
    • shapiq.game_theory
      • shapiq.game_theory.ExactComputer
      • shapiq.game_theory.MoebiusConverter
      • shapiq.game_theory.aggregate_base_interaction
      • shapiq.game_theory.get_bernoulli_weights
      • shapiq.game_theory.index_generalizes_sv
      • shapiq.game_theory.index_generalizes_bv
      • shapiq.game_theory.get_computation_index
      • shapiq.game_theory.is_index_aggregated
      • shapiq.game_theory.is_empty_value_the_baseline
      • shapiq.game_theory.egalitarian_least_core
    • shapiq.plot
      • shapiq.plot.network_plot
      • shapiq.plot.stacked_bar_plot
      • shapiq.plot.si_graph_plot
      • shapiq.plot.force_plot
      • shapiq.plot.bar_plot
      • shapiq.plot.waterfall_plot
      • shapiq.plot.sentence_plot
      • shapiq.plot.upset_plot
      • shapiq.plot.beeswarm_plot
      • shapiq.plot.scatter_plot
      • shapiq.plot.abbreviate_feature_names
    • shapiq.datasets
      • shapiq.datasets.load_bike_sharing
      • shapiq.datasets.load_adult_census
      • shapiq.datasets.load_california_housing
    • shapiq.utils
      • shapiq.utils.powerset
      • shapiq.utils.pair_subset_sizes
      • shapiq.utils.split_subsets_budget
      • shapiq.utils.get_explicit_subsets
      • shapiq.utils.generate_interaction_lookup
      • shapiq.utils.generate_interaction_lookup_from_coalitions
      • shapiq.utils.transform_coalitions_to_array
      • shapiq.utils.transform_array_to_coalitions
      • shapiq.utils.count_interactions
      • shapiq.utils.safe_isinstance
      • shapiq.utils.check_import_module
      • shapiq.utils.shuffle_data
      • shapiq.utils.raise_deprecation_warning
    • shapiq.tree
      • shapiq.tree.TreeSHAPIQ
      • shapiq.tree.TreeModel
      • shapiq.tree.InterventionalTreeExplainer
      • shapiq.tree.InterventionalGame
      • shapiq.tree.LinearTreeSHAP

BIBLIOGRAPHY

  • 💻 Related Software:
  • 📚 Bibliography
Back to top
View this page

Basics¶

Introductory examples covering core shapiq concepts: Shapley value computation, custom cooperative games, and parallel computation.

Parallel Computation with joblib

Parallel Computation with joblib

Defining Custom Games

Defining Custom Games

Computing Shapley Values

Computing Shapley Values
Next
Parallel Computation with joblib
Previous
ExactComputer
Copyright © 2024, Muschalik et al.
Made with Sphinx and @pradyunsg's Furo