Skip to content

Commit 069de73

Browse files
authored
Update pymc.LogNormal docsting (#5556)
* fixed pymc.LogNormal docsting * fixed pymc.LogNormal docsting
1 parent 44c5495 commit 069de73

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

pymc/distributions/continuous.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1712,15 +1712,15 @@ def logp(value, b, kappa, mu):
17121712

17131713
class LogNormal(PositiveContinuous):
17141714
r"""
1715-
Note: Class name Lognormal is deprecated, use LogNormal now!
1716-
17171715
Log-normal log-likelihood.
17181716
17191717
Distribution of any random variable whose logarithm is normally
17201718
distributed. A variable might be modeled as log-normal if it can
17211719
be thought of as the multiplicative product of many small
17221720
independent factors.
17231721
1722+
Note: Class name Lognormal is deprecated, use LogNormal now!
1723+
17241724
The pdf of this distribution is
17251725
17261726
.. math::
@@ -1730,6 +1730,7 @@ class LogNormal(PositiveContinuous):
17301730
\exp\left\{ -\frac{\tau}{2} (\ln(x)-\mu)^2 \right\}
17311731
17321732
.. plot::
1733+
:context: close-figs
17331734
17341735
import matplotlib.pyplot as plt
17351736
import numpy as np
@@ -1755,12 +1756,14 @@ class LogNormal(PositiveContinuous):
17551756
17561757
Parameters
17571758
----------
1758-
mu: float
1759+
mu : tensor_like of float, default 0
17591760
Location parameter.
1760-
sigma: float
1761+
sigma : tensor_like of float, optional
17611762
Standard deviation. (sigma > 0). (only required if tau is not specified).
1762-
tau: float
1763+
Defaults to 1.
1764+
tau : tensor_like of float, optional
17631765
Scale parameter (tau > 0). (only required if sigma is not specified).
1766+
Defaults to 1.
17641767
17651768
Examples
17661769
--------
@@ -1805,7 +1808,7 @@ def logcdf(value, mu, sigma):
18051808
18061809
Parameters
18071810
----------
1808-
value: numeric or np.ndarray or aesara.tensor
1811+
value : tensor_like of float
18091812
Value(s) for which log CDF is calculated. If the log CDF for multiple
18101813
values are desired the values must be provided in a numpy array or Aesara tensor.
18111814

0 commit comments

Comments
 (0)