CausalPy 0.2.2__tar.gz → 0.3.0__tar.gz

{CausalPy-0.2.2 → causalpy-0.3.0}/CausalPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CausalPy
-Version: 0.2.2
+Version: 0.3.0
 Summary: Causal inference for quasi-experiments in Python
 Author-email: Ben Vincent <ben.vincent@pymc-labs.com>
 License:                                  Apache License
@@ -208,7 +208,7 @@ License:                                  Apache License
 Project-URL: Homepage, https://github.com/pymc-labs/CausalPy
 Project-URL: Bug Reports, https://github.com/pymc-labs/CausalPy/issues
 Project-URL: Source, https://github.com/pymc-labs/CausalPy
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: arviz>=0.14.0
@@ -218,7 +218,7 @@ Requires-Dist: matplotlib>=3.5.3
 Requires-Dist: numpy<1.26.0
 Requires-Dist: pandas
 Requires-Dist: patsy
-Requires-Dist: pymc>=5.0.0
+Requires-Dist: pymc>=5.14.0
 Requires-Dist: scikit-learn>=1
 Requires-Dist: scipy
 Requires-Dist: seaborn>=0.11.2
@@ -231,8 +231,9 @@ Requires-Dist: twine; extra == "dev"
 Requires-Dist: interrogate; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: daft; extra == "docs"
 Requires-Dist: linkify-it-py; extra == "docs"
-Requires-Dist: myst-nb; extra == "docs"
+Requires-Dist: myst-nb<=1.0.0; extra == "docs"
 Requires-Dist: pathlib; extra == "docs"
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
@@ -430,7 +431,7 @@ Interrupted time series analysis is appropriate when you have a time series of o
 
 | Frequentist | Bayesian |
 |--|--|
-| coming soon | ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/interrupted_time_series_pymc.svg) |
+| ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/interrupted_time_series_skl.svg) | ![](https://raw.githubusercontent.com/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).
 
@@ -440,6 +441,17 @@ Instrumental Variable regression is an appropriate technique when you wish to es
 
 ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/iv_reg1.png)
 
+
+### Inverse Propensity Score Weighting
+
+Propensity scores are often used to address the risks of bias or confounding introduced in an observational study by
+selection effects into the treatment condition. Propensity scores can be used in a number of ways, but here we demonstrate
+their usage within corrective weighting schemes aimed to recover as-if random allocation of subjects to the treatment condition.
+The technique "up-weights" or "down-weights" individual observations to better estimate a causal estimand such as the average treatment
+effect.
+
+![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/propensity_weight.png)
+
 ## Learning resources
 
 Here are some general resources about causal inference:

{CausalPy-0.2.2 → causalpy-0.3.0}/CausalPy.egg-info/SOURCES.txt

@@ -28,6 +28,7 @@ causalpy/data/drinking.csv
 causalpy/data/geolift1.csv
 causalpy/data/its.csv
 causalpy/data/its_simple.csv
+causalpy/data/nhefs.csv
 causalpy/data/regression_discontinuity.csv
 causalpy/data/simulate_data.py
 causalpy/data/synthetic_control.csv

{CausalPy-0.2.2 → causalpy-0.3.0}/CausalPy.egg-info/requires.txt

@@ -5,7 +5,7 @@ matplotlib>=3.5.3
 numpy<1.26.0
 pandas
 patsy
-pymc>=5.0.0
+pymc>=5.14.0
 scikit-learn>=1
 scipy
 seaborn>=0.11.2
@@ -20,8 +20,9 @@ interrogate
 
 [docs]
 ipykernel
+daft
 linkify-it-py
-myst-nb
+myst-nb<=1.0.0
 pathlib
 sphinx
 sphinx-autodoc-typehints

{CausalPy-0.2.2 → causalpy-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CausalPy
-Version: 0.2.2
+Version: 0.3.0
 Summary: Causal inference for quasi-experiments in Python
 Author-email: Ben Vincent <ben.vincent@pymc-labs.com>
 License:                                  Apache License
@@ -208,7 +208,7 @@ License:                                  Apache License
 Project-URL: Homepage, https://github.com/pymc-labs/CausalPy
 Project-URL: Bug Reports, https://github.com/pymc-labs/CausalPy/issues
 Project-URL: Source, https://github.com/pymc-labs/CausalPy
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: arviz>=0.14.0
@@ -218,7 +218,7 @@ Requires-Dist: matplotlib>=3.5.3
 Requires-Dist: numpy<1.26.0
 Requires-Dist: pandas
 Requires-Dist: patsy
-Requires-Dist: pymc>=5.0.0
+Requires-Dist: pymc>=5.14.0
 Requires-Dist: scikit-learn>=1
 Requires-Dist: scipy
 Requires-Dist: seaborn>=0.11.2
@@ -231,8 +231,9 @@ Requires-Dist: twine; extra == "dev"
 Requires-Dist: interrogate; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: daft; extra == "docs"
 Requires-Dist: linkify-it-py; extra == "docs"
-Requires-Dist: myst-nb; extra == "docs"
+Requires-Dist: myst-nb<=1.0.0; extra == "docs"
 Requires-Dist: pathlib; extra == "docs"
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
@@ -430,7 +431,7 @@ Interrupted time series analysis is appropriate when you have a time series of o
 
 | Frequentist | Bayesian |
 |--|--|
-| coming soon | ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/interrupted_time_series_pymc.svg) |
+| ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/interrupted_time_series_skl.svg) | ![](https://raw.githubusercontent.com/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).
 
@@ -440,6 +441,17 @@ Instrumental Variable regression is an appropriate technique when you wish to es
 
 ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/iv_reg1.png)
 
+
+### Inverse Propensity Score Weighting
+
+Propensity scores are often used to address the risks of bias or confounding introduced in an observational study by
+selection effects into the treatment condition. Propensity scores can be used in a number of ways, but here we demonstrate
+their usage within corrective weighting schemes aimed to recover as-if random allocation of subjects to the treatment condition.
+The technique "up-weights" or "down-weights" individual observations to better estimate a causal estimand such as the average treatment
+effect.
+
+![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/propensity_weight.png)
+
 ## Learning resources
 
 Here are some general resources about causal inference:

{CausalPy-0.2.2 → causalpy-0.3.0}/README.md

@@ -178,7 +178,7 @@ Interrupted time series analysis is appropriate when you have a time series of o
 
 | Frequentist | Bayesian |
 |--|--|
-| coming soon | ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/interrupted_time_series_pymc.svg) |
+| ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/interrupted_time_series_skl.svg) | ![](https://raw.githubusercontent.com/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).
 
@@ -188,6 +188,17 @@ Instrumental Variable regression is an appropriate technique when you wish to es
 
 ![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/iv_reg1.png)
 
+
+### Inverse Propensity Score Weighting
+
+Propensity scores are often used to address the risks of bias or confounding introduced in an observational study by
+selection effects into the treatment condition. Propensity scores can be used in a number of ways, but here we demonstrate
+their usage within corrective weighting schemes aimed to recover as-if random allocation of subjects to the treatment condition.
+The technique "up-weights" or "down-weights" individual observations to better estimate a causal estimand such as the average treatment
+effect.
+
+![](https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/propensity_weight.png)
+
 ## Learning resources
 
 Here are some general resources about causal inference:

causalpy-0.3.0/causalpy/__init__.py

@@ -0,0 +1,30 @@
+#   Copyright 2024 The PyMC Labs Developers
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+import arviz as az
+
+from causalpy import pymc_experiments, pymc_models, skl_experiments, skl_models
+from causalpy.version import __version__
+
+from .data import load_data
+
+az.style.use("arviz-darkgrid")
+
+__all__ = [
+    "pymc_experiments",
+    "pymc_models",
+    "skl_experiments",
+    "skl_models",
+    "load_data",
+    "__version__",
+]

{CausalPy-0.2.2 → causalpy-0.3.0}/causalpy/custom_exceptions.py

@@ -1,3 +1,16 @@
+#   Copyright 2024 The PyMC Labs Developers
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
 """
 Custom Exceptions for CausalPy.
 """

causalpy-0.3.0/causalpy/data/__init__.py

@@ -0,0 +1,18 @@
+#   Copyright 2024 The PyMC Labs Developers
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+"""Code for loading datasets."""
+
+from .datasets import load_data
+
+__all__ = ["load_data"]

{CausalPy-0.2.2 → causalpy-0.3.0}/causalpy/data/datasets.py

@@ -1,6 +1,20 @@
+#   Copyright 2024 The PyMC Labs Developers
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
 """
 Functions to load example datasets
 """
+
 import pathlib
 
 import pandas as pd
@@ -20,6 +34,7 @@ DATASETS = {
     "anova1": {"filename": "ancova_generated.csv"},
     "geolift1": {"filename": "geolift1.csv"},
     "risk": {"filename": "AJR2001.csv"},
+    "nhefs": {"filename": "nhefs.csv"},
 }