From beb93e430575b2eddeed9abe115cbec0b99ffb14 Mon Sep 17 00:00:00 2001 From: "Benjamin T. Vincent" Date: Tue, 27 Sep 2022 20:04:56 +0100 Subject: [PATCH] add brief docstrings for the synthetic control and linear models --- causal_impact/causal_impact.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/causal_impact/causal_impact.py b/causal_impact/causal_impact.py index 40659a14..7bbba172 100644 --- a/causal_impact/causal_impact.py +++ b/causal_impact/causal_impact.py @@ -131,6 +131,8 @@ def calc_causal_impact(self): class SyntheticControl(CausalBase): + """This model is intended for use in synthetic control contexts. It's main feature is that it has a Dirichlet prior over the coefficients.""" + def build_model(self): COORDS = { "predictors": self.predictor_vars, @@ -157,6 +159,8 @@ def build_model(self): class LinearModel(CausalBase): + """Simple linear regression model. Useful for interrupted time series contexts with predictor variables""" + def build_model(self): COORDS = { "predictors": self.predictor_vars,