augsynth-py
A Python implementation of Augmented Synthetic Control Methods and geo-experimentation tooling. Methodologically faithful to the published literature, validated against the R reference implementations.
Status: alpha. The estimator API is functional and validated against R, but not yet stable across releases. Pin the exact version in production.
What this is
Synthetic control methods for causal inference, with a focus on the use case that matters most in modern marketing science: measuring the lift of geo-level ad campaigns. The roadmap targets feature parity with:
- The R
augsynthpackage (estimators). - Meta's R
GeoLiftpackage (orchestration: power analysis, market selection, multi-cell).
Why another synthetic control package
There are good Python options for parts of this problem (CausalPy,
pysyncon, tfcausalimpact), but none provides Augmented Synthetic Control
Methods (Ben-Michael, Feller & Rothstein 2021) together with the
GeoLift-style orchestration layer in a single Python-native package.
Installation
pip install augsynth-py
For the validation test suite (requires R and the augsynth R package):
pip install "augsynth-py[validation]"
Quickstart
import numpy as np
import polars as pl
from augsynth_py import AugSynth, conformal_pvalue
# Simulated geo panel: 20 markets x 90 days, +10% lift in geo_00 from day 70.
rng = np.random.default_rng(7)
days = np.arange(90)
base = rng.uniform(80, 120, 20)
trend = rng.normal(0.1, 0.05, 20)
seasonal = 5 * np.sin(2 * np.pi * days / 7)
panel = pl.concat(
pl.DataFrame(
{
"geo": f"geo_{i:02d}",
"day": days,
"sales": base[i] + trend[i] * days + seasonal + rng.normal(0, 1.0, 90),
}
)
for i in range(20)
).with_columns(
pl.when((pl.col("geo") == "geo_00") & (pl.col("day") >= 70))
.then(pl.col("sales") * 1.10)
.otherwise(pl.col("sales"))
.alias("sales")
)
fit = AugSynth(lambda_=1.0).fit(
panel,
unit="geo",
time="day",
outcome="sales",
treated="geo_00",
treatment_time=70,
)
print(f"ATT: {fit.att_:.2f} ({fit.att_pct_:+.1%})")
# ATT: 10.29 (+9.8%)
# The noise in this simulated panel is iid; on real (autocorrelated) series
# keep the default permutation_type="block".
p = conformal_pvalue(fit, permutation_type="iid", rng=np.random.default_rng(0))
print(f"conformal p-value: {p:.4f}")
# conformal p-value: 0.0120
What's available today:
Synth— classical simplex-constrained synthetic control (outcome-only form,augsynth(progfunc = "None", scm = TRUE)analogue), with optional unit fixed effects.AugSynth— ridge-augmented synthetic control (Ben-Michael, Feller & Rothstein 2021), with leave-one-out CV for the ridge penalty by default.conformal_pvalue/conformal_interval— exact conformal inference for a constant post-period effect (Chernozhukov, Wuthrich & Zhu 2021), block and iid permutation schemes.- Multi-treated fits: pass an iterable of units as
treatedto estimate the effect on the treated-group mean.
The GeoLift-style orchestration layer (power analysis, market selection) is the next milestone on the roadmap.
Methodological references
The implementation is based on the published literature, not translated from the R sources. Key references:
- Abadie, Diamond & Hainmueller (2010). Synthetic Control Methods for Comparative Case Studies. JASA.
- Ben-Michael, Feller & Rothstein (2021). The Augmented Synthetic Control Method. JASA.
- Xu (2017). Generalized Synthetic Control Method. Political Analysis.
- Chernozhukov, Wuthrich & Zhu (2021). An Exact and Robust Conformal Inference Method for Counterfactual and Synthetic Controls. JASA.
See docs/methodology.md for the mapping between code and equations.
Validation against R
Every estimator in this package is validated numerically against the R
reference implementation. The validation suite lives in
tests/validation_against_r/ and runs as a separate CI job.
If you find a discrepancy with the R output beyond documented tolerances, please open an issue — that is a bug.
Contributing
Read CLAUDE.md first. It contains the architectural decisions,
coding conventions, and the validation rule that PRs must satisfy.
License
MIT. See LICENSE.
Metadata
Release files for augsynth-py 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| augsynth_py-0.3.0.tar.gz | 107.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| augsynth_py-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 139.6 kB
Release files / augsynth_py-0.3.0.tar.gz
| Download URL | augsynth_py-0.3.0.tar.gz |
|---|---|
| Size | 107.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e6824e6a716ceb17c29ffd188f1fea9a86064001af3516317a161142bcb3758c
|
|
BLAKE2b-256 checksum How to use checksums |
98898ac64c67595ff18662438ff775476dc9cf8555596d8e72e76374d1322cb2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logRelease files / augsynth_py-0.3.0-py3-none-any.whl
| Download URL | augsynth_py-0.3.0-py3-none-any.whl |
|---|---|
| Size | 32.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
711ae35c5e4079dcb48388bf8a4b373db3a2e101505872be8e2bb21d59cbce3c
|
|
BLAKE2b-256 checksum How to use checksums |
7330269a2d6858f0ccc3ef781a0f3ae5f1a320622a68e3c3e5d456f3ddd4086d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency log