Skip to content

Commit 4bd1a2d

Browse files
ArmavicaricardoV94
authored andcommitted
Remove note that probs are automatically rescaled
This concerns the documentation of the Categorical and Multinomial distributions. Probabilities are indeed rescaled, but only when they are numeric, and with a warning to discourage users from that. Hence this should not be in the documentation. See issue #5978.
1 parent 093a734 commit 4bd1a2d

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

pymc/distributions/discrete.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -1268,8 +1268,7 @@ class Categorical(Discrete):
12681268
Parameters
12691269
----------
12701270
p : array of floats
1271-
p > 0 and the elements of p must sum to 1. They will be automatically
1272-
rescaled otherwise.
1271+
p > 0 and the elements of p must sum to 1.
12731272
logit_p : float
12741273
Alternative log odds for the probability of success.
12751274
"""

pymc/distributions/multivariate.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ class Multinomial(Discrete):
516516
p : tensor_like of float
517517
Probability of each one of the different outcomes (0 <= p <= 1). The number of
518518
categories is given by the length of the last axis. Elements are expected to sum
519-
to 1 along the last axis, and they will be automatically rescaled otherwise.
519+
to 1 along the last axis.
520520
"""
521521
rv_op = multinomial
522522

0 commit comments

Comments
 (0)