Skip to content

Commit d033d86

Browse files
committed
update framework docstrings
1 parent b76bdaf commit d033d86

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doubleml/double_ml_framework.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def all_ses(self):
106106
@property
107107
def t_stats(self):
108108
"""
109-
t-statistics for the causal parameter(s) (shape (``n_thetas``, )).
109+
t-statistics for the causal parameter(s) (shape (``n_thetas``,)).
110110
"""
111111
return self._thetas / self._ses
112112

@@ -120,7 +120,7 @@ def all_t_stats(self):
120120
@property
121121
def pvals(self):
122122
"""
123-
p-values for the causal parameter(s) (shape (``n_thetas``, )).
123+
p-values for the causal parameter(s) (shape (``n_thetas``,)).
124124
"""
125125
# aggregate p-values according to Definition 4.2 https://arxiv.org/abs/1712.04802
126126
pvals = np.median(self.all_pvals, axis=1)
@@ -165,7 +165,8 @@ def boot_method(self):
165165
@property
166166
def boot_t_stat(self):
167167
"""
168-
Bootstrapped t-statistics for the causal parameter(s) after calling :meth:`bootstrap`.
168+
Bootstrapped t-statistics for the causal parameter(s) after calling :meth:`bootstrap`
169+
(shape (``n_rep_boot``, ``n_thetas``, ``n_rep``)).
169170
"""
170171
return self._boot_t_stat
171172

0 commit comments

Comments
 (0)