This package contains several methods for calculating Conditional Average Treatment Effects
EconML: A Python Package for ML-Based Heterogeneous Treatment Effects Estimation
EconML is a Python package for estimating heterogeneous treatment effects from observational data via machine learning. This package was designed and built as part of the ALICE project at Microsoft Research with the goal to combine state-of-the-art machine learning techniques with econometrics to bring automation to complex causal inference problems. The promise of EconML:
- Implement recent techniques in the literature at the intersection of econometrics and machine learning
- Maintain flexibility in modeling the effect heterogeneity (via techniques such as random forests, boosting, lasso and neural nets), while preserving the causal interpretation of the learned model and often offering valid confidence intervals
- Use a unified API
- Build on standard Python packages for Machine Learning and Data Analysis
In a nutshell, this
toolkit is designed to measure the causal effect of some treatment variable(s)
T on an outcome
Y, controlling for a set of features
X. For detailed information about the package,
consult the documentation at https://econml.azurewebsites.net/.
Table of Contents
About Treatment Effect Estimation
One of the biggest promises of machine learning is to automate decision making in a multitude of domains. At the core of many data-driven personalized decision scenarios is the estimation of heterogeneous treatment effects: what is the causal effect of an intervention on an outcome of interest for a sample with a particular set of features?
Such questions arise frequently in customer segmentation (what is the effect of placing a customer in a tier over another tier), dynamic pricing (what is the effect of a pricing policy on demand) and medical studies (what is the effect of a treatment on a patient). In many such settings we have an abundance of observational data, where the treatment was chosen via some unknown policy, but the ability to run control A/B tests is limited.
Businesses offer personalized incentives to customers to increase sales and level of engagement. Any such personalized intervention corresponds to a monetary investment and the main question that business analytics are called to answer is: what is the return on investment? Analyzing the ROI is inherently a treatment effect question: what was the effect of any investment on a customer's spend? Understanding how ROI varies across customers can enable more targeted investment policies and increased ROI via better targeting.
Personalized discounts have are widespread in the digital economy. To set the optimal personalized discount policy a business needs to understand what is the effect of a drop in price on the demand of a customer for a product as a function of customer characteristics. The estimation of such personalized demand elasticities can also be phrased in the language of heterogeneous treatment effects, where the treatment is the price on the demand as a function of observable features of the customer.
Stratification in Clinical Trials
Which patients should be selected for a clinical trial? If we want to demonstrate that a clinical treatment has an effect on at least some subset of a population then fully randomized clinical trials are inappropriate as they will solely estimate average effects. Using heterogeneous treatment effect techniques, we can use observational data to come up with estimates of these effects and identify good candidate patients for a clinical trial that our model estimates have high treatment effects.
In the design of a page layout and ad placement, it is important to understand the click-through-rate of page components on different positions of a page. Modern approaches may be to run multiple A/B tests, but when such page component involve revenue considerations, then observational data can help guide correct A/B tests to run. Heterogeneous treatment effect estimation can provide estimates of the click-through-rate of page components from observational data. In this setting, the treatment is simply whether the component is placed on that page position and the response is whether the user clicked on it.
04/10/2019: Release v0.2, see release notes here.
03/06/2019: Release v0.1, welcome to have a try and provide feedback.
Install the latest release from PyPI:
pip install econml
To install from source, see For Developers section below.
from econml.dml import DMLCateEstimator from sklearn.linear_model import LassoCV est = DMLCateEstimator(model_y=LassoCV(), model_t=LassoCV) est.fit(Y, T, X, W) # W -> high-dimensional confounders, X -> features treatment_effects = est.const_marginal_effect(X_test)
from econml.ortho_forest import ContinuousTreatmentOrthoForest # Use defaults est = ContinuousTreatmentOrthoForest() # Or specify hyperparameters est = ContinuousTreatmentOrthoForest(n_trees=500, min_leaf_size=10, max_depth=10, subsample_ratio=0.7, lambda_reg=0.01, model_T=LassoCV(cv=3), model_Y=LassoCV(cv=3) ) est.fit(Y, T, X, W) treatment_effects = est.const_marginal_effect(X_test)
import keras from econml.deepiv import DeepIVEstimator treatment_model = keras.Sequential([keras.layers.Dense(128, activation='relu', input_shape=(2,)), keras.layers.Dropout(0.17), keras.layers.Dense(64, activation='relu'), keras.layers.Dropout(0.17), keras.layers.Dense(32, activation='relu'), keras.layers.Dropout(0.17)]) response_model = keras.Sequential([keras.layers.Dense(128, activation='relu', input_shape=(2,)), keras.layers.Dropout(0.17), keras.layers.Dense(64, activation='relu'), keras.layers.Dropout(0.17), keras.layers.Dense(32, activation='relu'), keras.layers.Dropout(0.17), keras.layers.Dense(1)]) est = DeepIVEstimator(n_components=10, # Number of gaussians in the mixture density networks) m=lambda z, x: treatment_model(keras.layers.concatenate([z, x])), # Treatment model h=lambda t, x: response_model(keras.layers.concatenate([t, x])), # Response model n_samples=1 # Number of samples used to estimate the response ) est.fit(Y, T, X, Z) # Z -> instrumental variables treatment_effects = est.effect(T0, T1, X_test)
Bootstrap Confidence Intervals
from econml.bootstrap import BootstrapEstimator # Bootstrap estimator wrapper boot_est = BootstrapEstimator(est, n_bootstrap_samples=10) boot_est.fit(Y, T, X, W) treatment_effect_interval = boot_est.const_marginal_effect_interval(X_test, lower=1, upper=99)
You can get started by cloning this repository. We use
setuptools for building and distributing our package.
We rely on some recent features of setuptools, so make sure to upgrade to a recent version with
pip install setuptools --upgrade. Then from your local copy of the repository you can run
python setup.py develop to get started.
Running the tests
This project uses pytest for testing. To run tests locally after installing the package,
you can use
python setup.py pytest.
Generating the documentation
This project's documentation is generated via Sphinx. To generate a local copy
of the documentation from a clone of this repository, just run
python setup.py build_sphinx, which will build the documentation and place it
The reStructuredText files that make up the documentation are stored in the docs directory; module documentation is automatically generated by the Sphinx build process.
Blogs and Publications
May 2019: Open Data Science Conference Workshop
2017: DeepIV paper
Contributing and Feedback
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
M. Oprescu, V. Syrgkanis and Z. S. Wu. Orthogonal Random Forest for Causal Inference. ArXiv preprint arXiv:1806.03467, 2018.
Jason Hartford, Greg Lewis, Kevin Leyton-Brown, and Matt Taddy. Deep IV: A flexible approach for counterfactual prediction. Proceedings of the 34th International Conference on Machine Learning, 2017.
V. Chernozhukov, D. Chetverikov, M. Demirer, E. Duflo, C. Hansen, and a. W. Newey. Double Machine Learning for Treatment and Causal Parameters. ArXiv preprint arXiv:1608.00060, 2016.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size econml-0.4-py3.6.egg (278.7 kB)||File type Egg||Python version 3.6||Upload date||Hashes View hashes|
|Filename, size econml-0.4-py3-none-any.whl (187.5 kB)||File type Wheel||Python version py3||Upload date||Hashes View hashes|
|Filename, size econml-0.4.tar.gz (170.8 kB)||File type Source||Python version None||Upload date||Hashes View hashes|