From 3bf89d4f3112616b060dcc7d88ff995e06d23475 Mon Sep 17 00:00:00 2001 From: Virgile Andreani Date: Thu, 25 Aug 2022 11:54:48 -0400 Subject: [PATCH] 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. --- pymc/distributions/discrete.py | 3 +-- pymc/distributions/multivariate.py | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/pymc/distributions/discrete.py b/pymc/distributions/discrete.py index 2215621a37..5af1bc3ca4 100644 --- a/pymc/distributions/discrete.py +++ b/pymc/distributions/discrete.py @@ -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. """ diff --git a/pymc/distributions/multivariate.py b/pymc/distributions/multivariate.py index 32b73139b4..cf4ed753bd 100644 --- a/pymc/distributions/multivariate.py +++ b/pymc/distributions/multivariate.py @@ -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