Skip to content

Commit 86f8d98

Browse files
authored
Update pymc.HalfStudentT docsting (#5555)
* fixed pymc.HalfStudentT docsting * added :context: close-figs and removed sd from dist * undo the sd change
1 parent a14e4f9 commit 86f8d98

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

pymc/distributions/continuous.py

+9-8
Original file line numberDiff line numberDiff line change
@@ -2691,7 +2691,7 @@ def rng_fn(cls, rng, nu, sigma, size=None) -> np.ndarray:
26912691

26922692
class HalfStudentT(PositiveContinuous):
26932693
r"""
2694-
Half Student's T log-likelihood
2694+
Half Student's T log-likelihood.
26952695
26962696
The pdf of this distribution is
26972697
@@ -2703,6 +2703,7 @@ class HalfStudentT(PositiveContinuous):
27032703
\left(1+\frac{1}{\nu}\frac{x^2}{\sigma^2}\right)^{-\frac{\nu+1}{2}}
27042704
27052705
.. plot::
2706+
:context: close-figs
27062707
27072708
import matplotlib.pyplot as plt
27082709
import numpy as np
@@ -2726,14 +2727,14 @@ class HalfStudentT(PositiveContinuous):
27262727
27272728
Parameters
27282729
----------
2729-
nu: float
2730+
nu : tensor_like of float, default 1
27302731
Degrees of freedom, also known as normality parameter (nu > 0).
2731-
sigma: float
2732+
sigma : tensor_like of float, optional
27322733
Scale parameter (sigma > 0). Converges to the standard deviation as nu
2733-
increases. (only required if lam is not specified)
2734-
lam: float
2734+
increases (only required if lam is not specified). Defaults to 1.
2735+
lam : tensor_like of float, optional
27352736
Scale parameter (lam > 0). Converges to the precision as nu
2736-
increases. (only required if sigma is not specified)
2737+
increases (only required if sigma is not specified). Defaults to 1.
27372738
27382739
Examples
27392740
--------
@@ -2776,9 +2777,9 @@ def logp(value, nu, sigma):
27762777
27772778
Parameters
27782779
----------
2779-
value: numeric
2780+
value : tensor_like of float
27802781
Value(s) for which log-probability is calculated. If the log probabilities for multiple
2781-
values are desired the values must be provided in a numpy array or Aesara tensor
2782+
values are desired the values must be provided in a numpy array or Aesara tensor.
27822783
27832784
Returns
27842785
-------

0 commit comments

Comments
 (0)