Skip to content

Commit 93aec5f

Browse files
committed
updated docs as well
1 parent 25dd8a4 commit 93aec5f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

cmdstanpy/stanfit/mcmc.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -448,11 +448,11 @@ def summary(
448448
) -> pd.DataFrame:
449449
"""
450450
Run cmdstan/bin/stansummary over all output CSV files, assemble
451-
summary into DataFrame object; first row contains summary statistics
452-
for total joint log probability `lp__`, remaining rows contain summary
451+
summary into DataFrame object. The first row contains statistics
452+
for the total joint log probability `lp__`, but is omitted when the
453+
Stan model has no parameters. The remaining rows contain summary
453454
statistics for all parameters, transformed parameters, and generated
454-
quantities variables listed in the order in which they were declared
455-
in the Stan program.
455+
quantities variables, in program declaration order.
456456
457457
:param percentiles: Ordered non-empty sequence of percentiles to report.
458458
Must be integers from (1, 99), inclusive. Defaults to

0 commit comments

Comments
 (0)