API reference

Generated from the docstrings in the source. The public API is what the three subpackages export:

Module	Contents
causalig.attr	CausalIntegratedGradients, CausalExpectedGradientsMultiStep, CausalExpectedGradients, and the lazily imported CausalSHAP and ConditionalSHAP.
causalig.models	MaskedGlobalLinear, train_surrogate_model, DifferentiableSCM, create_autoencoder_from_scm.
causalig.utils	DAG helpers and experiment logging.
Internals	The attribution base class, the surrogate contract and Jacobian computation, and path sampling. These are useful when extending the library.

The top-level package re-exports the three gradient methods:

import causalig

causalig.__version__
causalig.CausalIntegratedGradients        # same object as causalig.attr.CausalIntegratedGradients

• causalig.attr
  • Causal gradient methods
  • Shapley-value baselines
• causalig.models
  • Surrogates
  • Training
  • Structural causal models
• causalig.utils
  • Graph utilities
  • Logging
• Internals
  • Attribution base class
  • Surrogate contract and Jacobians
  • Path sampling