Skip to content
This repository was archived by the owner on Mar 19, 2021. It is now read-only.

Commit 29cc64b

Browse files
committed
DOC: add document about dtypes in plot, traceplot and extract
1 parent 73f4a11 commit 29cc64b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

pystan/stanfit4model.pyx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,11 @@ cdef class StanFit4Model:
491491
---------
492492
pars : {str, sequence of str}
493493
parameter name(s); by default use all parameters of interest
494+
dtypes : dict
495+
datatype of parameter(s).
496+
If nothing is passed, np.float will be used for all parameters.
497+
If np.int is specified, the histogram will be visualized, not but
498+
kde.
494499
495500
Note
496501
----
@@ -510,6 +515,11 @@ cdef class StanFit4Model:
510515
---------
511516
pars : {str, sequence of str}, optional
512517
parameter name(s); by default use all parameters of interest
518+
dtypes : dict
519+
datatype of parameter(s).
520+
If nothing is passed, np.float will be used for all parameters.
521+
If np.int is specified, the histogram will be visualized, not but
522+
kde.
513523
"""
514524
# FIXME: for now plot and traceplot do the same thing
515525
return self.plot(pars, dtypes=dtypes)
@@ -528,6 +538,9 @@ cdef class StanFit4Model:
528538
inc_warmup : bool
529539
If True, warmup samples are kept; otherwise they are
530540
discarded. If `permuted` is True, `inc_warmup` is ignored.
541+
dtypes : dict
542+
datatype of parameter(s).
543+
If nothing is passed, np.float will be used for all parameters.
531544
532545
Returns
533546
-------

0 commit comments

Comments
 (0)