Skip to content

Commit

Permalink
Remove note that probs are automatically rescaled
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Armavica authored and ricardoV94 committed Aug 25, 2022
1 parent 093a734 commit 4bd1a2d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
3 changes: 1 addition & 2 deletions pymc/distributions/discrete.py
Original file line number Diff line number Diff line change
Expand Up @@ -1268,8 +1268,7 @@ class Categorical(Discrete):
Parameters
----------
p : array of floats
p > 0 and the elements of p must sum to 1. They will be automatically
rescaled otherwise.
p > 0 and the elements of p must sum to 1.
logit_p : float
Alternative log odds for the probability of success.
"""
Expand Down
2 changes: 1 addition & 1 deletion pymc/distributions/multivariate.py
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ class Multinomial(Discrete):
p : tensor_like of float
Probability of each one of the different outcomes (0 <= p <= 1). The number of
categories is given by the length of the last axis. Elements are expected to sum
to 1 along the last axis, and they will be automatically rescaled otherwise.
to 1 along the last axis.
"""
rv_op = multinomial

Expand Down

0 comments on commit 4bd1a2d

Please sign in to comment.