g城堡

中文版本

版本 1.0.3 发布。

我们将于 2022/08/08 发布 1.0.3 版本。

介绍

gCastle是华为诺亚方舟实验室开发的因果结构学习工具链。该软件包包含与因果学习和评估相关的各种功能，包括：

• 数据生成与处理：数据模拟、数据读取算子、数据预处理算子（如先验注入、变量选择）。
• 因果结构学习：因果结构学习方法，包括经典的和最近开发的方法，尤其是可以处理大问题的基于梯度的方法。
• 评价指标：因果结构学习常用的各种指标，包括F1、SHD、FDR、TPR、FDR、NNZ等。

算法列表

安装

依赖项

gCastle 需要：

• 蟒蛇 (>= 3.6, <=3.9)
• tqdm (>= 4.48.2)
• numpy (>= 1.19.1)
• 熊猫 (>= 0.22.0)
• scipy (>= 1.7.3)
• scikit-learn (>= 0.21.1)
• matplotlib (>=2.1.2)
• 网络x (>= 2.5)
• 火炬（>= 1.9.0）

画中画安装

pip install gcastle==1.0.3

使用示例（PC 算法）

from castle.common import GraphDAG
from castle.metrics import MetricsDAG
from castle.datasets import IIDSimulation, DAG
from castle.algorithms import PC

# data simulation, simulate true causal dag and train_data.
weighted_random_dag = DAG.erdos_renyi(n_nodes=10, n_edges=10, 
                                      weight_range=(0.5, 2.0), seed=1)
dataset = IIDSimulation(W=weighted_random_dag, n=2000, method='linear', 
                        sem_type='gauss')
true_causal_matrix, X = dataset.B, dataset.X

# structure learning
pc = PC()
pc.learn(X)

# plot predict_dag and true_dag
GraphDAG(pc.causal_matrix, true_causal_matrix, 'result')

# calculate metrics
mt = MetricsDAG(pc.causal_matrix, true_causal_matrix)
print(mt.metrics)

您可以访问示例以查找更多示例。

引文

如果您发现 gCastle 在您的研究中有用，请考虑引用以下论文：

@misc{zhang2021gcastle,
  title={gCastle: A Python Toolbox for Causal Discovery}, 
  author={Keli Zhang and Shengyu Zhu and Marcus Kalander and Ignavier Ng and Junjian Ye and Zhitang Chen and Lujia Pan},
  year={2021},
  eprint={2111.15155},
  archivePrefix={arXiv},
  primaryClass={cs.LG}
}

下一步和贡献

这是 gCastle 的第一个发布版本，我们将不断补充和优化代码和文档。我们欢迎所有经验水平的新贡献者，关于如何贡献代码的规范即将发布。如果您有任何问题或建议（例如，贡献新算法、优化代码、改进文档），请在此处提交问题。我们会尽快回复。