Skip to main content

Baseline algorithms and analytics tools for Causal Discovery.

Project description

Latest version License: BSD Downloads

CausalDisco 🪩

CausalDisco provides baseline algorithms and analytics tools for Causal Discovery in Python. The package can be installed by running pip install CausalDisco. Additional information can be found in the documentation.

Baseline Algorithms

Find the following baseline algorithms in CausalDisco/baselines.py

  • R²-SortnRegress
  • Var-SortnRegress
  • Random-SortnRegress

Analytics Tools

Find the following analytics tools in CausalDisco/analytics.py

  • R²-sortability
  • Var-sortability
  • order_alignment

Sources

If you find our algorithms useful please consider citing

@inproceedings{reisach2023scale,
    title = {{A Scale-Invariant Sorting Criterion to Find a Causal Order in Additive Noise Models}},
    author = {Alexander G. Reisach and Myriam Tami and Christof Seiler and Antoine Chambaz and Sebastian Weichwald},
    booktitle = {{Advances in Neural Information Processing Systems 36 (NeurIPS)}},
    year = {2023},
    doi = {10.48550/arXiv.2303.18211},
}

@inproceedings{reisach2021beware,
    title = {{Beware of the Simulated DAG! Causal Discovery Benchmarks May Be Easy to Game}},
    author = {Alexander G. Reisach and Christof Seiler and Sebastian Weichwald},
    booktitle = {{Advances in Neural Information Processing Systems 34 (NeurIPS)}},
    year = {2021},
    doi = {10.48550/arXiv.2102.13647},
}

A Simple Example

# --- sample data from a linear SCM:

import numpy as np
from scipy import linalg

d = 10
W = np.diag(np.ones(d-1), 1)
X = np.random.randn(10000, d).dot(linalg.inv(np.eye(d) - W))
X_std = (X - np.mean(X, axis=0))/np.std(X, axis=0)

# --- run analytics and print results:

from CausalDisco.analytics import (
    var_sortability,
    r2_sortability,
    snr_sortability
)

print(
    f'True\n{W}\n'
    f'var-sortability={var_sortability(X, W):.2f}\n'
    f'R^2-sortability={r2_sortability(X, W):.2f}\n'
    f'SNR-sortability={snr_sortability(X, W):.2f}'
)

# --- run baselines and print results:

from CausalDisco.baselines import (
    random_sort_regress,
    var_sort_regress,
    r2_sort_regress
)

print(
    f'True\n{W}\n'
    '--- randomRegress ---\n'
    f'Recovered:\n{1.0*(random_sort_regress(X)!=0)}\n'
    f'Recovered standardized:\n{1.0*(random_sort_regress(X_std)!=0)}\n'
    '--- varSortnRegress ---\n'
    f'Recovered:\n{1.0*(var_sort_regress(X)!=0)}\n'
    f'Recovered standardized:\n{1.0*(var_sort_regress(X_std)!=0)}\n'
    '--- r2SortnRegress ---\n'
    f'Recovered:\n{1.0*(r2_sort_regress(X)!=0)}\n'
    f'Recovered standardized:\n{1.0*(r2_sort_regress(X_std)!=0)}\n'
)

Shout out to Anne Helby Petersen for coming up with the "causal disco" naming idea first (check out her causalDisco package providing tools for causal discovery on observational data in R).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

causaldisco-0.2.4.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

causaldisco-0.2.4-py2.py3-none-any.whl (8.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file causaldisco-0.2.4.tar.gz.

File metadata

  • Download URL: causaldisco-0.2.4.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for causaldisco-0.2.4.tar.gz
Algorithm Hash digest
SHA256 1a1e30ac242328e47a8c94f8f566c0c2c4e713670fe165ff99ed5b2d0528d09e
MD5 0cb0f87a54bd69756b0c57fb6ad7e212
BLAKE2b-256 7be6eae10fe473b935e7bb84b4e0cfbe55a9585963de621904efc34ed9a4c2b5

See more details on using hashes here.

File details

Details for the file causaldisco-0.2.4-py2.py3-none-any.whl.

File metadata

  • Download URL: causaldisco-0.2.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for causaldisco-0.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 006fd2269bbebf20f6ba5a51472ac5279611d98a3ce37562b6d031d3f385dea5
MD5 961dd7d791020c467e5d7d180ac1f6ab
BLAKE2b-256 216b57e023fc6b9c2b93b6f95b9a1c9b8e3bd377be6b45ec6e338b955c9dc3dd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page