Skip to content

Fix missing images on PyPI page #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 15, 2023
Merged

Fix missing images on PyPI page #270

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<a href="https://github.com/pymc-labs/CausalPy"><img width="60%" src="docs/source/_static/logo.png"></a>
<a href="https://github.com/pymc-labs/CausalPy"><img width="60%" src="https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/logo.png"></a>
</div>

----
Expand Down Expand Up @@ -82,7 +82,7 @@ This is appropriate when you have multiple units, one of which is treated. You b

| Frequentist | Bayesian |
|--|--|
| ![](docs/source/_static/synthetic_control_skl.svg) | ![](docs/source/_static/synthetic_control_pymc.svg) |
| ![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/synthetic_control_skl.svg) | ![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/synthetic_control_pymc.svg) |

> The data (treated and untreated units), pre-treatment model fit, and counterfactual (i.e. the synthetic control) are plotted (top). The causal impact is shown as a blue shaded region. The Bayesian analysis shows shaded Bayesian credible regions of the model fit and counterfactual. Also shown is the causal impact (middle) and cumulative causal impact (bottom).

Expand Down Expand Up @@ -121,7 +121,7 @@ Data is expected to be in the following form. Shown are just two units - one in

| Frequentist | Bayesian |
|--|--|
| ![](docs/source/_static/difference_in_differences_skl.svg) | ![](docs/source/_static/difference_in_differences_pymc.svg) |
| ![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/difference_in_differences_skl.svg) | ![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/difference_in_differences_pymc.svg) |

>The data, model fit, and counterfactual are plotted. Frequentist model fits result in points estimates, but the Bayesian analysis results in posterior distributions, represented by the violin plots. The causal impact is the difference between the counterfactual prediction (treated group, post treatment) and the observed values for the treated group, post treatment.

Expand All @@ -140,7 +140,7 @@ Regression discontinuity designs are used when treatment is applied to units acc

| Frequentist | Bayesian |
|--|--|
| ![](docs/source/_static/regression_discontinuity_skl.svg) | ![](docs/source/_static/regression_discontinuity_pymc.svg) |
| ![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/regression_discontinuity_skl.svg) | ![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/regression_discontinuity_pymc.svg) |

> The data, model fit, and counterfactual are plotted (top). Frequentist analysis shows the causal impact with the blue shaded region, but this is not shown in the Bayesian analysis to avoid a cluttered chart. Instead, the Bayesian analysis shows shaded Bayesian credible regions of the model fits. The Frequentist analysis visualises the point estimate of the causal impact, but the Bayesian analysis also plots the posterior distribution of the regression discontinuity effect (bottom).

Expand All @@ -159,7 +159,7 @@ Regression discontinuity designs are used when treatment is applied to units acc

| Frequentist | Bayesian |
|--|--|
| coming soon | ![](docs/source/_static/regression_kink_pymc.svg) |
| coming soon | ![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/regression_kink_pymc.svg) |

> The data and model fit. The Bayesian analysis shows the posterior mean with credible intervals (shaded regions). We also report the Bayesian $R^2$ on the data along with the posterior mean and credible intervals of the change in gradient at the kink point.

Expand All @@ -178,15 +178,15 @@ Interrupted time series analysis is appropriate when you have a time series of o

| Frequentist | Bayesian |
|--|--|
| coming soon | ![](docs/source/_static/interrupted_time_series_pymc.svg) |
| coming soon | ![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/interrupted_time_series_pymc.svg) |

> The data, pre-treatment model fit, and counterfactual are plotted (top). The causal impact is shown as a blue shaded region. The Bayesian analysis shows shaded Bayesian credible regions of the model fit and counterfactual. Also shown is the causal impact (middle) and cumulative causal impact (bottom).

### Instrumental Variable Regression

Instrumental Variable regression is an appropriate technique when you wish to estimate the treatment effect of some variable on another, but are concerned that the treatment variable is endogenous in the system of interest i.e. correlated with the errors. In this case an “instrument” variable can be used in a regression context to disentangle treatment effect due to the threat of confounding due to endogeneity.

![](docs/source/_static/iv_reg1.png)
![](https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/iv_reg1.png)

## Learning resources

Expand All @@ -207,7 +207,7 @@ Here are some general resources about causal inference:

## Support

<img src="docs/source/_static/pymc-labs-log.png" align="right" width="50%" />
<img src="https://github.com/raw/pymc-labs/CausalPy/main/docs/source/_static/pymc-labs-log.png" align="right" width="50%" />

This repository is supported by [PyMC Labs](https://www.pymc-labs.com).

Expand Down