Skip to main content

Python causal inference modules

Project description

codecov Code style: black

Pycausal-explorer

Pycausal-explorer is a python module for causal inference and treatment effect estimation. It implements a set of algorithms that supports causal analysis.

Installation Guide

You can install the package through pip:

pip install pycausal-explorer

Basic Usage

All models are inherited from BaseCausalModel, that inherits from scikit-learn BaseEstimator. It uses scikit-learn framework to fit and predict the outcome. It implements predict_ite and predict_ate methods that return the individual treatment effect and the average treatment effect, respectively.

from pycausal_explorer.datasets.synthetic import create_synthetic_data
from pycausal_explorer.meta import XLearner

x, treatment, y = create_synthetic_data()
model = XLearner()
model.fit(x, treatment, y)
treatment_effect = model.predict_ite(x)

Current Implemented Models

This version currently implements propensity score and iptw in the reweight package, linear regression in the linear package, causal forests in forest package and x-learn in meta package.

Using Pipelines

Pycausal-explorer has a Pipeline class inherited from scikit-learn Pipeline. It implements the method predict_ite, so it can be used pro predict treatment effect in a pipeline:

from sklearn.preprocessing import StandardScaler

from pycausal_explorer.datasets.synthetic import create_synthetic_data
from pycausal_explorer.pipeline import Pipeline
from pycausal_explorer.reweight import IPTW

x, w, y = create_synthetic_data()
pipe = Pipeline([("norm", StandardScaler()), ("clf", IPTW())])
pipe.fit(x, y, clf__treatment=w)
treatment_effect = pipe.predict_ite(x)

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

pycausal-explorer-0.2.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

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

pycausal_explorer-0.2.0-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file pycausal-explorer-0.2.0.tar.gz.

File metadata

  • Download URL: pycausal-explorer-0.2.0.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for pycausal-explorer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9275638038fbba7e4d8d2ba12aca30cb2ab0ca1dc512d02b133e6dd6a903849a
MD5 58374bcc7750d7bd79939bf31eebf676
BLAKE2b-256 ffb352255e28f10c640773ddaef6debeeb8c474587233727be3ee5bc12c943a0

See more details on using hashes here.

File details

Details for the file pycausal_explorer-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pycausal_explorer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4c2fdfd99958045fbfc5808fa54d7e638d2c33fc1bf3d50f837ac9f7653336f
MD5 cce433129cecd01bb6961d29d391261e
BLAKE2b-256 1577973e7e4c623c92f671f3bbcf5af242775467f5bdff8ebcc7fac581846f58

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