Skip to content

Commit c290397

Browse files
committed
Docs changes
1 parent d6827d4 commit c290397

2 files changed

Lines changed: 6 additions & 1 deletion

File tree

cmdstanpy/stanfit/metadata.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,7 @@ def method_vars(self) -> Dict[str, stanio.Variable]:
4747

4848
@property
4949
def stan_vars(self) -> Dict[str, stanio.Variable]:
50+
"""
51+
These are the user-defined variables in the Stan program.
52+
"""
5053
return self._stan_vars

cmdstanpy/stanfit/vb.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,9 @@ def stan_variable(self, var: str) -> np.ndarray:
117117
"""
118118
Return a numpy.ndarray which contains the estimates for the
119119
for the named Stan program variable where the dimensions of the
120-
numpy.ndarray match the shape of the Stan program variable.
120+
numpy.ndarray match the shape of the Stan program variable, with
121+
a leading axis added for the number of draws from the variational
122+
approximation.
121123
122124
This functionaltiy is also available via a shortcut using ``.`` -
123125
writing ``fit.a`` is a synonym for ``fit.stan_variable("a")``

0 commit comments

Comments
 (0)