Skip to content

update docstrings in ZeroInflatedPoisson, DiracDelta and OrderedLogistic classes #5962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 13, 2022
Merged

update docstrings in ZeroInflatedPoisson, DiracDelta and OrderedLogistic classes #5962

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e34014
update docstrings in BetaBinomial class
saurbhc Jul 9, 2022
647ba83
update docstrings in ZeroInflatedPoisson, DiracDelta and OrderedLogis…
saurbhc Jul 9, 2022
aa3a073
add close-figs context on plot directive in ZeroInflatedPoisson class
saurbhc Jul 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions pymc/distributions/discrete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,11 @@ def BetaBinom(a, b, n, x):

Parameters
----------
n: int
n : tensor_like of int
Number of Bernoulli trials (n >= 0).
alpha: float
alpha : tensor_like of float
alpha > 0.
beta: float
beta : tensor_like of float
beta > 0.
"""

Expand Down Expand Up @@ -1365,7 +1365,7 @@ class DiracDelta(Discrete):

Parameters
----------
c: float or int
c : tensor_like of float or int
Dirac Delta parameter. The dtype of `c` determines the dtype of the distribution.
This can affect which sampler is assigned to DiracDelta variables, or variables
that use DiracDelta, such as Mixtures.
Expand Down Expand Up @@ -1463,6 +1463,7 @@ class ZeroInflatedPoisson:
\end{array} \right.

.. plot::
:context: close-figs

import matplotlib.pyplot as plt
import numpy as np
Expand Down Expand Up @@ -1491,9 +1492,9 @@ class ZeroInflatedPoisson:

Parameters
----------
psi: float
psi : tensor_like of float
Expected proportion of Poisson variates (0 < psi < 1)
mu: float
mu : tensor_like of float
Expected number of occurrences during the given interval
(mu >= 0).
"""
Expand Down Expand Up @@ -1726,9 +1727,9 @@ class OrderedLogistic:

Parameters
----------
eta: float
eta : tensor_like of float
The predictor.
cutpoints: array
cutpoints : tensor_like of array
The length K - 1 array of cutpoints which break :math:`\eta` into
ranges. Do not explicitly set the first and last elements of
:math:`c` to negative and positive infinity.
Expand Down