Skip to content

Commit 620c92d

Browse files
authored
Updated pymc.InverseGamma docstring (#5499)
1 parent 8d06985 commit 620c92d

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

pymc/distributions/continuous.py

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2340,7 +2340,7 @@ def logcdf(value, alpha, inv_beta):
23402340
23412341
Parameters
23422342
----------
2343-
value : tensor_like
2343+
value : tensor_like of float
23442344
Value(s) for which log CDF is calculated. If the log CDF for
23452345
multiple values are desired the values must be provided in a numpy
23462346
array or `TensorVariable`.
@@ -2372,6 +2372,7 @@ class InverseGamma(PositiveContinuous):
23722372
\exp\left(\frac{-\beta}{x}\right)
23732373
23742374
.. plot::
2375+
:context: close-figs
23752376
23762377
import matplotlib.pyplot as plt
23772378
import numpy as np
@@ -2398,13 +2399,13 @@ class InverseGamma(PositiveContinuous):
23982399
23992400
Parameters
24002401
----------
2401-
alpha: float
2402+
alpha : tensor_like of float, optional
24022403
Shape parameter (alpha > 0).
2403-
beta: float
2404+
beta : tensor_like of float, optional
24042405
Scale parameter (beta > 0).
2405-
mu: float
2406+
mu : tensor_like of float, optional
24062407
Alternative shape parameter (mu > 0).
2407-
sigma: float
2408+
sigma : tensor_like of float, optional
24082409
Alternative scale parameter (sigma > 0).
24092410
"""
24102411
rv_op = invgamma
@@ -2460,14 +2461,19 @@ def _distr_parameters_for_repr(self):
24602461

24612462
def logcdf(value, alpha, beta):
24622463
"""
2463-
Compute the log of the cumulative distribution function for Inverse Gamma distribution
2464-
at the specified value.
2464+
Compute the log of the cumulative distribution function for Inverse Gamma
2465+
distribution at the specified value.
24652466
24662467
Parameters
24672468
----------
2468-
value: numeric or np.ndarray or aesara.tensor
2469+
value : tensor_like of float
24692470
Value(s) for which log CDF is calculated. If the log CDF for multiple
2470-
values are desired the values must be provided in a numpy array or Aesara tensor.
2471+
values are desired the values must be provided in a numpy array or Aesara
2472+
tensor.
2473+
alpha : tensor_like of float
2474+
Shape parameter (alpha > 0).
2475+
beta : tensor_like of float
2476+
Scale parameter (beta > 0).
24712477
24722478
Returns
24732479
-------

0 commit comments

Comments
 (0)