安装

从 PyPi 安装最新版本

pip install causaltune

注意

Mac/OS 用户:在某些机器上,作为 AutoML / Flaml 依赖项的 LightGBM 包可能无法自动正确安装。在这种情况下,一个解决方法是设置一个 conda 环境并通过 conda-forge 频道安装 LightGBM

conda create -n <my_env> python=3.9.16
conda activate <my_env>
pip install causaltune
conda install -c conda-forge lightgbm

快速开始

CausalTune 包可以像 scikit 风格的估计器一样使用

from causaltune import CausalTune
from causaltune.datasets import synth_ihdp

# prepare dataset
data = synth_ihdp()
data.preprocess_dataset()


# init CausalTune object with chosen metric to optimise
ct = CausalTune(time_budget=600, metric="energy_distance")

# run CausalTune
ct.fit(data)

# return best estimator
print(f"Best estimator: {ct.best_estimator}")

开发者须知

克隆此仓库并在仓库的顶层文件夹中运行以下命令。

pip install -r requirements-dev.txt

该项目使用 pytest 进行测试。在安装包后,您可以在本地运行以下命令来执行测试

python setup.py pytest

要求

CausalTune 需要以下包

  • numpy

  • pandas

  • econml

  • dowhy

  • flaml

  • scikit-learn

  • matplotlib

  • dcor

  • wise-pizza

  • seaborn

如果您克隆了此仓库,可以通过以下方式安装它们

pip install -r requirements.txt