causasv 0.8.6

Causal feature attribution via Asymmetric Shapley Values (ASV) over DAGs — Rust + Python
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

#![forbid(unsafe_code)]
//! Fast Causal Asymmetric Shapley Values for DAGs.
//!
//! # Quick Start
//!
//! ```rust
//! use causasv::{AsvExplainer, CausasvError, Dag};
//!
//! fn main() -> Result<(), CausasvError> {
//!     let mut dag = Dag::new();
//!     let x = dag.add_node("X");
//!     let y = dag.add_node("Y");
//!     dag.add_edge(x, y)?;
//!
//!     let explainer = AsvExplainer::new(dag);
//!     let result = explainer.exact(|coalition| Ok(coalition.len() as f64))?;
//!
//!     for (id, val) in &result.values {
//!         println!("{id:?} = {val:.4}");
//!     }
//!     Ok(())
//! }
//! ```
//!
//! For large graphs use [`AsvExplainer::approximate`] or [`AsvExplainer::auto`].
//! See the [README](https://github.com/kent-tokyo/causasv) for Python usage and benchmarks.

mod approx;
mod cache;
mod dag_dp;
mod dag_dp_sparse;
mod error;
mod graph;
mod numerics;
mod sampler;
mod topo;
mod tree;
mod value_function;

pub mod asv;

#[cfg(feature = "python")]
pub mod python;

pub use asv::{AsvExplainer, AsvResult};
pub use dag_dp_sparse::ExactDagConfig;
pub use error::CausasvError;
pub use graph::{Dag, NodeId};
pub use sampler::{AdaptiveSamplingConfig, SamplingConfig};
pub use topo::{enumerate_topos, topo_sort};
pub use value_function::ValueFn;