Skip to content

Commit

Permalink
add brief docstrings for the synthetic control and linear models
Browse files Browse the repository at this point in the history
  • Loading branch information
drbenvincent committed Sep 27, 2022
1 parent cd2b520 commit beb93e4
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions causal_impact/causal_impact.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down

0 comments on commit beb93e4

Please sign in to comment.