From 9d547dedb29fc276de64085ec7d63c86d64d272b Mon Sep 17 00:00:00 2001 From: julianlheureux <“lheureuxjulian@gmail.com”> Date: Wed, 28 Aug 2024 15:05:16 -0300 Subject: [PATCH] Add docstring2 --- bambi/backend/utils.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bambi/backend/utils.py b/bambi/backend/utils.py index 625afad3..50f772a0 100644 --- a/bambi/backend/utils.py +++ b/bambi/backend/utils.py @@ -7,7 +7,7 @@ def horseshoe(name, tau_nu=3, lam_nu=1, dims=None): - """Simulate a beta coefficient value with a horseshoe prior. + """Simulate a beta coefficient value with a horseshoe prior. This is an internal function which is not supposed to be used by users. This will be used only when a horseshoe prior is called for beta coefficients. @@ -25,7 +25,7 @@ def horseshoe(name, tau_nu=3, lam_nu=1, dims=None): Returns ------ np.ndarray - Array with the beta coefficient simulated. + Array with the beta coefficient simulated. """ tau = pm.HalfStudentT(f"{name}_tau", nu=tau_nu) lam = pm.HalfStudentT(f"{name}_lam", nu=lam_nu, dims=dims)