Skip to main content

A Python package for causal inference using Bayesian structural time-series models

This is a port of the R package CausalImpact, see: https://github.com/google/CausalImpact.

This package implements an approach to estimating the causal effect of a designed intervention on a time series. For example, how many additional daily clicks were generated by an advertising campaign? Answering a question like this can be difficult when a randomized experiment is not available. The package aims to address this difficulty using a structural Bayesian time-series model to estimate how the response metric might have evolved after the intervention if the intervention had not occurred.

As with all approaches to causal inference on non-experimental data, valid conclusions require strong assumptions. The CausalImpact package, in particular, assumes that the outcome time series can be explained in terms of a set of control time series that were themselves not affected by the intervention. Furthermore, the relation between treated series and control series is assumed to be stable during the post-intervention period. Understanding and checking these assumptions for any given application is critical for obtaining valid conclusions.

Try it out in the browser

Binder

Installation

install the latest release via pip

pip install causalimpactx

Getting started

Documentation and examples

Further resources

Bugs

The issue tracker is at https://github.com/yaseenesmaeelpour/causalimpactx/issues. Please report any bugs that you find. Or, even better, fork the repository on GitHub and create a pull request.

Release files for causalimpactx 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for causalimpactx 1.0.0
File Size Uploaded
causalimpactx-1.0.0.tar.gz 28.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for causalimpactx 1.0.0
File Interpreter ABI Platform
causalimpactx-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 49.0 kB

Release files / causalimpactx-1.0.0.tar.gz

Download URL causalimpactx-1.0.0.tar.gz
Size 28.2 kB
Tags Source
SHA-256 checksum
How to use checksums
9629e1cae28201eac6884a13f8c6ef4cda7f34d4f95374b987892437d07c0fdb
BLAKE2b-256 checksum
How to use checksums
763e35ff43c854a27a299a5a16bc83a9b38f5880405269b2937ba28519c6d84a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.2

Release files / causalimpactx-1.0.0-py3-none-any.whl

Download URL causalimpactx-1.0.0-py3-none-any.whl
Size 20.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ad281bd50580fff904f7bd7c4b9a85ee054cdb14a18a899d82d58a44c7b335a4
BLAKE2b-256 checksum
How to use checksums
f07df0f84a68a3b4e68890ab95c80a906017e33eae4ecbcbb8972d2a0d2e2eea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.2

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page