Skip to content

Commit 729f79c

Browse files
authored
Review docstrings checkmarcked as best practice (#5919)
1 parent 0b4f248 commit 729f79c

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

docs/source/api/aesaraf.rst

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Aesara utils
66
.. autosummary::
77
:toctree: generated/
88

9+
compile_pymc
910
gradient
1011
hessian
1112
hessian_diag

docs/source/conf.py

+2
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@
8181
"SMC_kernel": ":ref:`SMC Kernel <smc_kernels>`",
8282
"Aesara_Op": ":class:`Aesara Op <aesara.graph.op.Op>`",
8383
"tensor_like": ":term:`tensor_like`",
84+
"numpy_Generator": ":class:`~numpy.random.Generator`",
85+
"Distribution": ":ref:`Distribution <api_distributions>`",
8486
}
8587

8688
# Show the documentation of __init__ and the class docstring

pymc/distributions/continuous.py

-4
Original file line numberDiff line numberDiff line change
@@ -1653,10 +1653,6 @@ class AsymmetricLaplace(Continuous):
16531653
Location parameter.
16541654
b : tensor_like of float
16551655
Scale parameter (b > 0).
1656-
1657-
See Also:
1658-
--------
1659-
`Reference <https://en.wikipedia.org/wiki/Asymmetric_Laplace_distribution>`_
16601656
"""
16611657
rv_op = asymmetriclaplace
16621658

pymc/distributions/discrete.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -988,11 +988,11 @@ class HyperGeometric(Discrete):
988988
989989
Parameters
990990
----------
991-
N : tensor_like of integer
991+
N : tensor_like of int
992992
Total size of the population (N > 0)
993-
k : tensor_like of integer
993+
k : tensor_like of int
994994
Number of successful individuals in the population (0 <= k <= N)
995-
n : tensor_like of integer
995+
n : tensor_like of int
996996
Number of samples drawn from the population (0 <= n <= N)
997997
"""
998998

pymc/distributions/timeseries.py

+8-7
Original file line numberDiff line numberDiff line change
@@ -217,16 +217,17 @@ def rng_fn(
217217

218218

219219
class GaussianRandomWalk(distribution.Continuous):
220-
r"""Random Walk with Normal innovations
220+
r"""Random Walk with Normal innovations.
221221
222222
Parameters
223223
----------
224-
mu : tensor_like of float
225-
innovation drift, defaults to 0.0
226-
sigma : tensor_like of float, optional
227-
sigma > 0, innovation standard deviation, defaults to 1.0
228-
init_dist : unnamed distribution
229-
Univariate distribution of the initial value, created with the `.dist()` API.
224+
mu : tensor_like of float, default 0
225+
innovation drift
226+
sigma : tensor_like of float, default 1
227+
sigma > 0, innovation standard deviation.
228+
init_dist : Distribution
229+
Unnamed univariate distribution of the initial value. Unnamed refers to distributions
230+
created with the ``.dist()`` API.
230231
231232
.. warning:: init will be cloned, rendering them independent of the ones passed as input.
232233

pymc/sampling.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -2277,14 +2277,14 @@ def draw(
22772277
22782278
Parameters
22792279
----------
2280-
vars : Variable or iterable of Variable
2280+
vars : TensorVariable or iterable of TensorVariable
22812281
A variable or a list of variables for which to draw samples.
22822282
draws : int, default 1
22832283
Number of samples needed to draw.
2284-
random_seed : int, RandomState or Generator, optional
2284+
random_seed : int, RandomState or numpy_Generator, optional
22852285
Seed for the random number generator.
22862286
**kwargs : dict, optional
2287-
Keyword arguments for :func:`pymc.aesara.compile_pymc`.
2287+
Keyword arguments for :func:`pymc.aesaraf.compile_pymc`.
22882288
22892289
Returns
22902290
-------

0 commit comments

Comments
 (0)