From 2f6cb4d9b16ee974e9e40572df32a3d7e10bfe7a Mon Sep 17 00:00:00 2001 From: unknown Date: Mon, 29 Aug 2022 12:07:17 -0700 Subject: [PATCH 1/2] Updated pymc.AR docstring --- pymc/distributions/timeseries.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/pymc/distributions/timeseries.py b/pymc/distributions/timeseries.py index 4b39b38059..95bd6719e6 100644 --- a/pymc/distributions/timeseries.py +++ b/pymc/distributions/timeseries.py @@ -361,25 +361,25 @@ class AR(SymbolicDistribution): Parameters ---------- - rho: tensor_like of float + rho : tensor_like of float Tensor of autoregressive coefficients. The n-th entry in the last dimension is the coefficient for the n-th lag. - sigma: tensor_like of float, optional - Standard deviation of innovation (sigma > 0). Defaults to 1. Only required if + sigma : tensor_like of float, default 1 + Standard deviation of innovation (sigma > 0). Only required if tau is not specified. - tau: tensor_like of float + tau : tensor_like of float, optional Precision of innovation (tau > 0). - constant: bool, optional + constant : bool, default False Whether the first element of rho should be used as a constant term in the AR - process. Defaults to False - init_dist: unnamed distribution - Scalar or vector distribution for initial values. Distribution should be - created via the `.dist()` API, and have shape (*shape[:-1], ar_order). If not, - it will be automatically resized. + process. + init_dist : unnamed distribution + Scalar or vector distribution for initial values. Unnamed refers to distributions + created with the ``.dist()`` API. Distributions should have shape (*shape[:-1], ar_order). + If not, it will be automatically resized. .. warning:: init_dist will be cloned, rendering it independent of the one passed as input. - ar_order: int, optional + ar_order : int, optional Order of the AR process. Inferred from length of the last dimension of rho, if possible. ar_order = rho.shape[-1] if constant else rho.shape[-1] - 1 steps : int, optional From 0683b0aaf889df79f17f3fbd59fc6e235626611a Mon Sep 17 00:00:00 2001 From: unknown Date: Mon, 29 Aug 2022 12:31:31 -0700 Subject: [PATCH 2/2] Updated pymc.AR docstring --- pymc/distributions/timeseries.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pymc/distributions/timeseries.py b/pymc/distributions/timeseries.py index 95bd6719e6..9fbc509174 100644 --- a/pymc/distributions/timeseries.py +++ b/pymc/distributions/timeseries.py @@ -372,10 +372,10 @@ class AR(SymbolicDistribution): constant : bool, default False Whether the first element of rho should be used as a constant term in the AR process. - init_dist : unnamed distribution + init_dist : unnamed distribution, optional Scalar or vector distribution for initial values. Unnamed refers to distributions created with the ``.dist()`` API. Distributions should have shape (*shape[:-1], ar_order). - If not, it will be automatically resized. + If not, it will be automatically resized. Defaults to pm.Normal.dist(0, 100, shape=...). .. warning:: init_dist will be cloned, rendering it independent of the one passed as input.