Skip to content

Commit 2638420

Browse files
committed
remove uninformative examples from docstring
1 parent b22e443 commit 2638420

File tree

1 file changed

+0
-29
lines changed

1 file changed

+0
-29
lines changed

causalpy/experiments/base.py

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -173,35 +173,6 @@ def effect_summary(
173173
-------
174174
EffectSummary
175175
Object with .table (DataFrame) and .text (str) attributes
176-
177-
Examples
178-
--------
179-
Interrupted Time Series (PyMC):
180-
181-
import causalpy as cp
182-
result = cp.InterruptedTimeSeries(..., model=cp.pymc_models.LinearRegression(...))
183-
stats = result.effect_summary()
184-
print(stats.table)
185-
print(stats.text)
186-
187-
Interrupted Time Series (OLS):
188-
189-
from sklearn.linear_model import LinearRegression
190-
result = cp.InterruptedTimeSeries(..., model=LinearRegression())
191-
stats = result.effect_summary()
192-
print(stats.table)
193-
194-
Difference-in-Differences:
195-
196-
result = cp.DifferenceInDifferences(...)
197-
stats = result.effect_summary()
198-
print(stats.table)
199-
200-
Regression Discontinuity:
201-
202-
result = cp.RegressionDiscontinuity(...)
203-
stats = result.effect_summary()
204-
print(stats.table)
205176
"""
206177
# Detect experiment type
207178
experiment_type = _detect_experiment_type(self)

0 commit comments

Comments
 (0)