Skip to content

Commit

Permalink
Tweak docstrings and function call signature for AR
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanhmorris committed Sep 10, 2024
1 parent c0375c3 commit 618a0d2
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions pyrenew/process/ar.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ def sample(
autoreg: ArrayLike,
init_vals: ArrayLike,
noise_sd: float | ArrayLike,
**kwargs,
) -> tuple:
"""
Sample from the AR process
Expand All @@ -42,18 +41,15 @@ def sample(
Array of initial values. Must have the
same first dimension size as the order.
noise_sd : float | ArrayLike
Scalar giving the s.d. of the AR
Standard deviation of the AR
process Normal noise, which by
definition has mean 0.
**kwargs : dict, optional
Additional keyword arguments passed to
self.noise_rv_.sample()
Returns
-------
tuple
With a single SampledValue containing an
array of shape (n,).
array of shape (n,) + init_vals.shape.
"""
noise_sd_arr = jnp.atleast_1d(noise_sd)
if not noise_sd_arr.shape == (1,):
Expand Down

0 comments on commit 618a0d2

Please sign in to comment.