Skip to content

Commit 278c107

Browse files
fonnesbeckspringcoil
authored andcommitted
Deprecated Constant class (#2452)
* Moved Constant to subclass of Continuous * Added missing distributions from distributions api docs * Changed Constant to be subclass of Distribution * Reverted changes and added deprecation warning for Constant * Moved Constant reference in init * Moved Constant reference in init * Added Constant to discrete.rst * Fixed import error * Removed duplicate/redundant warning for ConstantDist
1 parent 0e14c11 commit 278c107

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

docs/source/api/distributions/continuous.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,28 @@ Continuous
77

88
Uniform
99
Flat
10+
HalfFlat
1011
Normal
12+
HalfNormal
13+
SkewNormal
1114
Beta
1215
Exponential
1316
Laplace
1417
StudentT
18+
StudentTpos
1519
Cauchy
1620
HalfCauchy
1721
Gamma
1822
Weibull
19-
StudentTpos
2023
Lognormal
2124
ChiSquared
22-
HalfNormal
2325
Wald
2426
Pareto
2527
InverseGamma
2628
ExGaussian
29+
VonMises
30+
Triangular
31+
Gumbel
2732

2833
.. automodule:: pymc3.distributions.continuous
2934
:members:

docs/source/api/distributions/discrete.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,18 @@ Discrete
66
.. autosummary::
77

88
Binomial
9+
ZeroInflatedBinomial
910
BetaBinomial
1011
Bernoulli
1112
Poisson
13+
ZeroInflatedPoisson
1214
NegativeBinomial
13-
ConstantDist
1415
ZeroInflatedPoisson
1516
DiscreteUniform
1617
Geometric
1718
Categorical
19+
DiscreteWeibull
20+
Constant
1821

1922
.. automodule:: pymc3.distributions.discrete
2023
:members:

pymc3/distributions/discrete.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import theano
44
import theano.tensor as tt
55
from scipy import stats
6+
import warnings
67

78
from pymc3.util import get_variable_name
89
from .dist_math import bound, factln, binomln, betaln, logpow
@@ -555,6 +556,8 @@ class Constant(Discrete):
555556
"""
556557

557558
def __init__(self, c, *args, **kwargs):
559+
warnings.warn("Constant has been deprecated. We recommend using a Determinstic object instead.",
560+
DeprecationWarning)
558561
super(Constant, self).__init__(*args, **kwargs)
559562
self.mean = self.median = self.mode = self.c = c = tt.as_tensor_variable(c)
560563

@@ -578,11 +581,7 @@ def _repr_latex_(self, name=None, dist=None):
578581
return r'${} \sim \text{{Constant}}()$'.format(name)
579582

580583

581-
def ConstantDist(*args, **kwargs):
582-
import warnings
583-
warnings.warn("ConstantDist has been deprecated. In future, use Constant instead.",
584-
DeprecationWarning)
585-
return Constant(*args, **kwargs)
584+
ConstantDist = Constant
586585

587586

588587
class ZeroInflatedPoisson(Discrete):

0 commit comments

Comments
 (0)