graph-explain 0.7.2__tar.gz → 0.7.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. {graph_explain-0.7.2/src/graph_explain.egg-info → graph_explain-0.7.3}/PKG-INFO +14 -15
  2. {graph_explain-0.7.2 → graph_explain-0.7.3}/README.md +12 -13
  3. {graph_explain-0.7.2 → graph_explain-0.7.3}/pyproject.toml +2 -2
  4. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/__init__.py +1 -1
  5. {graph_explain-0.7.2 → graph_explain-0.7.3/src/graph_explain.egg-info}/PKG-INFO +14 -15
  6. {graph_explain-0.7.2 → graph_explain-0.7.3}/LICENSE +0 -0
  7. {graph_explain-0.7.2 → graph_explain-0.7.3}/setup.cfg +0 -0
  8. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/backends/__init__.py +0 -0
  9. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/backends/base.py +0 -0
  10. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/backends/dgl.py +0 -0
  11. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/benchmarks/__init__.py +0 -0
  12. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/benchmarks/synthetic.py +0 -0
  13. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/cli.py +0 -0
  14. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/core/__init__.py +0 -0
  15. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/core/benchmark.py +0 -0
  16. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/core/evaluation.py +0 -0
  17. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/core/explainer.py +0 -0
  18. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/core/explanation.py +0 -0
  19. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/core/model_utils.py +0 -0
  20. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/core/registry.py +0 -0
  21. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/__init__.py +0 -0
  22. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/attention/attention.py +0 -0
  23. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/base.py +0 -0
  24. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/baseline/random_baseline.py +0 -0
  25. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/counterfactual/counterfactual.py +0 -0
  26. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/feature/graph_lime.py +0 -0
  27. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/gradient/__init__.py +0 -0
  28. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/gradient/grad_x_input.py +0 -0
  29. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/gradient/guided_backprop.py +0 -0
  30. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/gradient/integrated_gradients.py +0 -0
  31. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/gradient/saliency.py +0 -0
  32. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/perturbation/__init__.py +0 -0
  33. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/perturbation/gnn_explainer.py +0 -0
  34. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/perturbation/node_mask.py +0 -0
  35. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/perturbation/pg_explainer.py +0 -0
  36. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/perturbation/subgraphx.py +0 -0
  37. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/relevance/deeplift.py +0 -0
  38. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/methods/relevance/gnn_lrp.py +0 -0
  39. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/narration/__init__.py +0 -0
  40. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/narration/narrator.py +0 -0
  41. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/py.typed +0 -0
  42. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/visualization/__init__.py +0 -0
  43. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/visualization/interactive.py +0 -0
  44. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/visualization/static.py +0 -0
  45. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain.egg-info/SOURCES.txt +0 -0
  46. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain.egg-info/dependency_links.txt +0 -0
  47. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain.egg-info/entry_points.txt +0 -0
  48. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain.egg-info/requires.txt +0 -0
  49. {graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain.egg-info/top_level.txt +0 -0
  50. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_cli.py +0 -0
  51. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_core.py +0 -0
  52. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_counterfactual.py +0 -0
  53. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_dgl_integration.py +0 -0
  54. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_narration.py +0 -0
  55. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_phase10.py +0 -0
  56. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_phase2.py +0 -0
  57. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_phase3.py +0 -0
  58. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_phase4.py +0 -0
  59. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_phase6.py +0 -0
  60. {graph_explain-0.7.2 → graph_explain-0.7.3}/tests/test_phase8.py +0 -0
{graph_explain-0.7.2/src/graph_explain.egg-info → graph_explain-0.7.3}/PKG-INFO RENAMED
@@ -1,12 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: graph-explain
3
- Version: 0.7.2
3
+ Version: 0.7.3
4
4
  Summary: Explainability library for graph-based models (GNN)
5
5
  Author: graph-explain contributors
6
6
  License-Expression: MIT
7
7
  Project-URL: Homepage, https://github.com/Tzinny-dev/graph-explain
8
8
  Project-URL: Repository, https://github.com/Tzinny-dev/graph-explain
9
- Project-URL: Documentation, https://github.com/Tzinny-dev/graph-explain#readme
9
+ Project-URL: Documentation, https://tzinny-dev.github.io/graph-explain/
10
10
  Keywords: gnn,explainability,xai,graph,neural-networks,interpretability
11
11
  Classifier: Development Status :: 4 - Beta
12
12
  Classifier: Intended Audience :: Science/Research
@@ -52,6 +52,12 @@ Dynamic: license-file
52
52
 
53
53
  # graph-explain
54
54
 
55
+ [![CI](https://github.com/Tzinny-dev/graph-explain/actions/workflows/ci.yml/badge.svg)](https://github.com/Tzinny-dev/graph-explain/actions/workflows/ci.yml)
56
+ [![docs](https://github.com/Tzinny-dev/graph-explain/actions/workflows/docs.yml/badge.svg)](https://tzinny-dev.github.io/graph-explain/)
57
+ [![PyPI](https://img.shields.io/pypi/v/graph-explain.svg)](https://pypi.org/project/graph-explain/)
58
+ [![Python](https://img.shields.io/pypi/pyversions/graph-explain.svg)](https://pypi.org/project/graph-explain/)
59
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Tzinny-dev/graph-explain/blob/main/LICENSE)
60
+
55
61
  Explainability library for graph-based models (Graph Neural Networks).
56
62
  Explains a GNN's predictions in terms of **important nodes, edges and subgraphs**,
57
63
  with built-in metrics and visualization.
@@ -120,6 +126,9 @@ pip install -e .[all]
120
126
  Optional extras: `pyg` (PyTorch Geometric), `dgl` (DGL backend),
121
127
  `interactive` (plotly/pyvis).
122
128
 
129
+ > 📚 **Documentation**: full API reference and guides at
130
+ > https://tzinny-dev.github.io/graph-explain/
131
+
123
132
  ## Quick start
124
133
 
125
134
  ```python
@@ -320,19 +329,9 @@ Node-only methods (`GraphLIME`, `NodeMask`, `Attention`, `GNNGatedLRP`,
320
329
 
321
330
  ## Roadmap
322
331
 
323
- - [x] Phase 2: PGExplainer, SubgraphX, Integrated Gradients
324
- - [x] Phase 2: interactive visualization (pyvis → HTML)
325
- - [x] Phase 3: full metrics (fidelity±, stability, GEA)
326
- - [x] Phase 3: DGL backend (adapter; integration validated with DGL 2.1 + torch 2.2.1)
327
- - [x] Phase 4: GNN-LRP (layer-wise relevance for GCNs; validates the house motif in BA-Shapes)
328
- - [x] Phase 4: counterfactual explanations (minimal edge/feature removal that changes the class)
329
- - [x] Phase 4: LLM narration (`describe` deterministic + pluggable `narrate` LLM)
330
- - [x] Phase 5: full CLI (all methods, metrics, narration and JSON export)
331
- - [x] Phase 6: more methods (DeepLIFT rescale, Attention/GAT, Gradient×Input)
332
- - [x] Phase 7: comparative benchmark (`compare` + CLI `bench` subcommand, table and JSON/HTML reports)
333
- - [x] Phase 8: more methods (GraphLIME, NodeMask, GuidedBackprop and Random baseline)
334
- - [x] Phase 10: graph-level explanations (graph-classification dataset with house
335
- motif, graph-level GEA, CLI/bench without `--node` and `graph_level` flag)
332
+ Planned ideas (real-world Datasets, more methods, robustness metrics) are
333
+ tracked as issues in the repository — see
334
+ https://github.com/Tzinny-dev/graph-explain/issues
336
335
 
337
336
  ## License
338
337
 
{graph_explain-0.7.2 → graph_explain-0.7.3}/README.md RENAMED
@@ -1,5 +1,11 @@
1
1
  # graph-explain
2
2
 
3
+ [![CI](https://github.com/Tzinny-dev/graph-explain/actions/workflows/ci.yml/badge.svg)](https://github.com/Tzinny-dev/graph-explain/actions/workflows/ci.yml)
4
+ [![docs](https://github.com/Tzinny-dev/graph-explain/actions/workflows/docs.yml/badge.svg)](https://tzinny-dev.github.io/graph-explain/)
5
+ [![PyPI](https://img.shields.io/pypi/v/graph-explain.svg)](https://pypi.org/project/graph-explain/)
6
+ [![Python](https://img.shields.io/pypi/pyversions/graph-explain.svg)](https://pypi.org/project/graph-explain/)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Tzinny-dev/graph-explain/blob/main/LICENSE)
8
+
3
9
  Explainability library for graph-based models (Graph Neural Networks).
4
10
  Explains a GNN's predictions in terms of **important nodes, edges and subgraphs**,
5
11
  with built-in metrics and visualization.
@@ -68,6 +74,9 @@ pip install -e .[all]
68
74
  Optional extras: `pyg` (PyTorch Geometric), `dgl` (DGL backend),
69
75
  `interactive` (plotly/pyvis).
70
76
 
77
+ > 📚 **Documentation**: full API reference and guides at
78
+ > https://tzinny-dev.github.io/graph-explain/
79
+
71
80
  ## Quick start
72
81
 
73
82
  ```python
@@ -268,19 +277,9 @@ Node-only methods (`GraphLIME`, `NodeMask`, `Attention`, `GNNGatedLRP`,
268
277
 
269
278
  ## Roadmap
270
279
 
271
- - [x] Phase 2: PGExplainer, SubgraphX, Integrated Gradients
272
- - [x] Phase 2: interactive visualization (pyvis → HTML)
273
- - [x] Phase 3: full metrics (fidelity±, stability, GEA)
274
- - [x] Phase 3: DGL backend (adapter; integration validated with DGL 2.1 + torch 2.2.1)
275
- - [x] Phase 4: GNN-LRP (layer-wise relevance for GCNs; validates the house motif in BA-Shapes)
276
- - [x] Phase 4: counterfactual explanations (minimal edge/feature removal that changes the class)
277
- - [x] Phase 4: LLM narration (`describe` deterministic + pluggable `narrate` LLM)
278
- - [x] Phase 5: full CLI (all methods, metrics, narration and JSON export)
279
- - [x] Phase 6: more methods (DeepLIFT rescale, Attention/GAT, Gradient×Input)
280
- - [x] Phase 7: comparative benchmark (`compare` + CLI `bench` subcommand, table and JSON/HTML reports)
281
- - [x] Phase 8: more methods (GraphLIME, NodeMask, GuidedBackprop and Random baseline)
282
- - [x] Phase 10: graph-level explanations (graph-classification dataset with house
283
- motif, graph-level GEA, CLI/bench without `--node` and `graph_level` flag)
280
+ Planned ideas (real-world Datasets, more methods, robustness metrics) are
281
+ tracked as issues in the repository — see
282
+ https://github.com/Tzinny-dev/graph-explain/issues
284
283
 
285
284
  ## License
286
285
 
{graph_explain-0.7.2 → graph_explain-0.7.3}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "graph-explain"
7
- version = "0.7.2"
7
+ version = "0.7.3"
8
8
  description = "Explainability library for graph-based models (GNN)"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
@@ -41,7 +41,7 @@ dependencies = [
41
41
  [project.urls]
42
42
  Homepage = "https://github.com/Tzinny-dev/graph-explain"
43
43
  Repository = "https://github.com/Tzinny-dev/graph-explain"
44
- Documentation = "https://github.com/Tzinny-dev/graph-explain#readme"
44
+ Documentation = "https://tzinny-dev.github.io/graph-explain/"
45
45
 
46
46
  [project.optional-dependencies]
47
47
  pyg = ["torch>=2.0", "torch-geometric>=2.5"]
{graph_explain-0.7.2 → graph_explain-0.7.3}/src/graph_explain/__init__.py RENAMED
@@ -35,7 +35,7 @@ from .methods import (
35
35
  from .narration import Narrator, describe, narrate, summarize
36
36
  from .visualization import show, visualize_interactive, visualize_static
37
37
 
38
- __version__ = "0.7.2"
38
+ __version__ = "0.7.3"
39
39
 
40
40
  __all__ = [
41
41
  "AttentionExplainer",
{graph_explain-0.7.2 → graph_explain-0.7.3/src/graph_explain.egg-info}/PKG-INFO RENAMED
@@ -1,12 +1,12 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: graph-explain
3
- Version: 0.7.2
3
+ Version: 0.7.3
4
4
  Summary: Explainability library for graph-based models (GNN)
5
5
  Author: graph-explain contributors
6
6
  License-Expression: MIT
7
7
  Project-URL: Homepage, https://github.com/Tzinny-dev/graph-explain
8
8
  Project-URL: Repository, https://github.com/Tzinny-dev/graph-explain
9
- Project-URL: Documentation, https://github.com/Tzinny-dev/graph-explain#readme
9
+ Project-URL: Documentation, https://tzinny-dev.github.io/graph-explain/
10
10
  Keywords: gnn,explainability,xai,graph,neural-networks,interpretability
11
11
  Classifier: Development Status :: 4 - Beta
12
12
  Classifier: Intended Audience :: Science/Research
@@ -52,6 +52,12 @@ Dynamic: license-file
52
52
 
53
53
  # graph-explain
54
54
 
55
+ [![CI](https://github.com/Tzinny-dev/graph-explain/actions/workflows/ci.yml/badge.svg)](https://github.com/Tzinny-dev/graph-explain/actions/workflows/ci.yml)
56
+ [![docs](https://github.com/Tzinny-dev/graph-explain/actions/workflows/docs.yml/badge.svg)](https://tzinny-dev.github.io/graph-explain/)
57
+ [![PyPI](https://img.shields.io/pypi/v/graph-explain.svg)](https://pypi.org/project/graph-explain/)
58
+ [![Python](https://img.shields.io/pypi/pyversions/graph-explain.svg)](https://pypi.org/project/graph-explain/)
59
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Tzinny-dev/graph-explain/blob/main/LICENSE)
60
+
55
61
  Explainability library for graph-based models (Graph Neural Networks).
56
62
  Explains a GNN's predictions in terms of **important nodes, edges and subgraphs**,
57
63
  with built-in metrics and visualization.
@@ -120,6 +126,9 @@ pip install -e .[all]
120
126
  Optional extras: `pyg` (PyTorch Geometric), `dgl` (DGL backend),
121
127
  `interactive` (plotly/pyvis).
122
128
 
129
+ > 📚 **Documentation**: full API reference and guides at
130
+ > https://tzinny-dev.github.io/graph-explain/
131
+
123
132
  ## Quick start
124
133
 
125
134
  ```python
@@ -320,19 +329,9 @@ Node-only methods (`GraphLIME`, `NodeMask`, `Attention`, `GNNGatedLRP`,
320
329
 
321
330
  ## Roadmap
322
331
 
323
- - [x] Phase 2: PGExplainer, SubgraphX, Integrated Gradients
324
- - [x] Phase 2: interactive visualization (pyvis → HTML)
325
- - [x] Phase 3: full metrics (fidelity±, stability, GEA)
326
- - [x] Phase 3: DGL backend (adapter; integration validated with DGL 2.1 + torch 2.2.1)
327
- - [x] Phase 4: GNN-LRP (layer-wise relevance for GCNs; validates the house motif in BA-Shapes)
328
- - [x] Phase 4: counterfactual explanations (minimal edge/feature removal that changes the class)
329
- - [x] Phase 4: LLM narration (`describe` deterministic + pluggable `narrate` LLM)
330
- - [x] Phase 5: full CLI (all methods, metrics, narration and JSON export)
331
- - [x] Phase 6: more methods (DeepLIFT rescale, Attention/GAT, Gradient×Input)
332
- - [x] Phase 7: comparative benchmark (`compare` + CLI `bench` subcommand, table and JSON/HTML reports)
333
- - [x] Phase 8: more methods (GraphLIME, NodeMask, GuidedBackprop and Random baseline)
334
- - [x] Phase 10: graph-level explanations (graph-classification dataset with house
335
- motif, graph-level GEA, CLI/bench without `--node` and `graph_level` flag)
332
+ Planned ideas (real-world Datasets, more methods, robustness metrics) are
333
+ tracked as issues in the repository — see
334
+ https://github.com/Tzinny-dev/graph-explain/issues
336
335
 
337
336
  ## License
338
337
 
{graph_explain-0.7.2 → graph_explain-0.7.3}/LICENSE RENAMED
File without changes
{graph_explain-0.7.2 → graph_explain-0.7.3}/setup.cfg RENAMED
File without changes