Skip to content

Commit 82dc0f5

Browse files
committed
Harmonize Multinomial, Dirichlet and DirichletMultinomial docstrings
1 parent 4ed1042 commit 82dc0f5

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

pymc/distributions/multivariate.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -406,8 +406,9 @@ class Dirichlet(Continuous):
406406
407407
Parameters
408408
----------
409-
a: array
410-
Concentration parameters (a > 0).
409+
a: float array
410+
Concentration parameters (a > 0). The number of categories is given by the
411+
length of the last axis.
411412
"""
412413
rv_op = dirichlet
413414

@@ -508,10 +509,11 @@ class Multinomial(Discrete):
508509
Parameters
509510
----------
510511
n: int
511-
Number of trials (n > 0)
512-
p: vector
513-
Probability of each one of the different outcomes. Elements must be non-negative
514-
and sum to 1 along the last axis. They will be automatically rescaled otherwise.
512+
Total counts in each replicate (n > 0).
513+
p: float array
514+
Probability of each one of the different outcomes (0 <= p <= 1). The number of
515+
categories is given by the length of the last axis. Elements are expected to sum
516+
to 1 along the last axis, and they will be automatically rescaled otherwise.
515517
"""
516518
rv_op = multinomial
517519

@@ -625,11 +627,11 @@ class DirichletMultinomial(Discrete):
625627
Parameters
626628
----------
627629
n : int
628-
Total counts in each replicate.
630+
Total counts in each replicate (n > 0).
629631
630-
a : vector
631-
Dirichlet alpha parameter. Elements must be strictly positive. The number of
632-
categories is given by the length of the last axis.
632+
a : float array
633+
Dirichlet concentration parameters (a > 0). The number of categories is given by
634+
the length of the last axis.
633635
"""
634636
rv_op = dirichlet_multinomial
635637

0 commit comments

Comments
 (0)