A library to compute Shapley values in graphs.
Project description
ShapG: a fast and exactly approach to approximate the Shaple value on graph
Installation
pip install shapG
Features
- Exact Shapley value computation for small to medium-sized graphs
- Fast approximate Shapley value computation for large graphs using local search
- Visualization tools for Shapley values
- Utility functions for graph generation and analysis
Quick Start
import networkx as nx
from shapG.shapley import shapG, graph_generator
from shapG.plot import plot
# Generate a random graph
G = graph_generator(n_nodes=10, density=0.5)
# Compute approximate Shapley values
shapley_values = shapG(G, depth=1, m=15)
# Visualize the results
plot(shapley_values, top_n=10)
Advanced Usage
Custom Characteristic Function
You can define a custom characteristic function:
def my_coalition_function(G, S):
# Your custom characteristic function
subgraph = G.subgraph(S)
return nx.density(subgraph) * len(S)
# Use your custom function
shapley_values = shapG(G, f=my_coalition_function)
More example, see ./examples.
Customizing the Plot
fig, ax = plot(
shapley_values,
top_n=5, # Show only top 5 values
style='seaborn-v0_8', # Matplotlib style
file_name="shapley.eps", # Save to file
title="Node Importance", # Custom title
figsize=(10, 6), # Figure size (width, height)
color="#2E86C1", # Bar color
show_values=True, # Show values next to bars
value_format="{:.4f}", # Format for displayed values
show_plot: bool = False # Show plot
)
# Further customize the plot using matplotlib objects
ax.set_xlabel("Contribution Score", fontsize=14)
plt.show()
License
MIT License
Citation
If you find this code useful in your research, please consider citing:
- For centralities measures:
@article{zhao2024centralitymeasuresopiniondynamics, title={Centrality measures and opinion dynamics in two-layer networks with replica nodes}, author={Chi Zhao and Elena Parilina}, year={2024}, eprint={2406.18780}, archivePrefix={arXiv}, primaryClass={physics.soc-ph}, journal={arXiv preprint arXiv:2406.18780}, url={https://arxiv.org/abs/2406.18780}, } - For the new method for explanable ai:
@article{ZHAO2025110409, title = {ShapG: New feature importance method based on the Shapley value}, journal = {Engineering Applications of Artificial Intelligence}, volume = {148}, pages = {110409}, year = {2025}, issn = {0952-1976}, doi = {https://doi.org/10.1016/j.engappai.2025.110409}, url = {https://www.sciencedirect.com/science/article/pii/S0952197625004099}, author = {Chi Zhao and Jing Liu and Elena Parilina}, }
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
shapg-0.13.4.tar.gz
(13.4 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
shapg-0.13.4-py3-none-any.whl
(11.8 kB
view details)
File details
Details for the file shapg-0.13.4.tar.gz.
File metadata
- Download URL: shapg-0.13.4.tar.gz
- Upload date:
- Size: 13.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2150041f7b1f3572f6823f5212a039b904844c15a8e29911d756fc2d9dbfe768
|
|
| MD5 |
ed0be6a70935695e9cf17fb8456e748e
|
|
| BLAKE2b-256 |
a514711c81282ec769bcee79044f689a10fa0eb5263076b7e5aa24f6a82a60f4
|
File details
Details for the file shapg-0.13.4-py3-none-any.whl.
File metadata
- Download URL: shapg-0.13.4-py3-none-any.whl
- Upload date:
- Size: 11.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
59dda32bf36251dfa024fdf17672e36a1b3adbb3bbccf0c5a347a00a39a17de4
|
|
| MD5 |
7bd916612ef4557fa3df90a06fd21684
|
|
| BLAKE2b-256 |
ad00b756de3c0b343f44d157da592ec76f1c8457d3728a7c8556e08750878271
|