Getting started

Installation

Requirements

python 3 (>=3.7)
numpy
networkx
pandas
scipy
scikit-learn
statsmodels
pydot

(For visualization)

matplotlib
graphviz
pygraphviz (might not support the most recent Mac)

Install via PyPI

To use causal-learn, we could install it using pip:

(.venv) $ pip install causal-learn

Install from source

For development version, please kindly refer to our GitHub Repository.

Running examples

For search methods in causal discovery, there are various running examples in the ‘tests’ directory in our GitHub Repository, such as TestPC.py and TestGES.py.

For the implemented modules, such as (conditional) independent test methods, we provide unit tests for the convenience of developing your own methods.

Benchmarks

For the convenience of our community, CMU-CLeaR group maintains a list of benchmark datasets including real-world scenarios and various learning tasks. Please refer to the following links:

https://github.com/cmu-phil/example-causal-datasets (maintained by Joseph Ramsey)
https://www.cmu.edu/dietrich/causality/causal-learn

Please feel free to let us know if you have any recommendation regarding causal datasets with high-quality. We are grateful for any effort that benefits the development of causality community.

Contributors

Team Leaders: Kun Zhang, Joseph Ramsey, Mingming Gong, Ruichu Cai, Shohei Shimizu, Peter Spirtes, Clark Glymour

Coordinators: Yujia Zheng, Biwei Huang, Wei Chen

Developers:

Wei Chen, Biwei Huang, Yuequn Liu, Zhiyi Huang, Feng Xie, Haoyue Dai, Xiaokai Huang: PC, FCI, GES, GIN, and graph operations.
Mingming Gong, Erdun Gao, Aoqi Zuo: PNL, ANM, Granger causality, and KCI.
Shohei Shimizu, Takashi Nicholas Maeda, Takashi Ikeuchi: LiNGAM-based methods.
Madelyn Glymour: several helpers.
Ruibo Tu: Missing-value/test-wise deletion PC.
Wai-Yin Lam: PC.
Biwei Huang: CD-NOD.
Ignavier Ng, Yujia Zheng: Exact search.
Bryan Andrews, Joseph Ramsey: GRaSP.
Joseph Ramsey, Wei Chen, Zhiyi Huang: Evaluations.

Quality control: Yewen Fan, Haoyue Dai, Yujia Zheng, Ignavier Ng, Xiangchen Song

Citation

Please cite as:

@article{zheng2024causal,
  title={Causal-learn: Causal discovery in python},
  author={Zheng, Yujia and Huang, Biwei and Chen, Wei and Ramsey, Joseph and Gong, Mingming and Cai, Ruichu and Shimizu, Shohei and Spirtes, Peter and Zhang, Kun},
  journal={Journal of Machine Learning Research},
  volume={25},
  number={60},
  pages={1--8},
  year={2024}
}