From dc926d9576421f935ebed33060738c5f08143d4e Mon Sep 17 00:00:00 2001 From: Paul Xu Date: Thu, 16 Nov 2023 11:05:54 -0500 Subject: [PATCH] Fix docstring for hssm.Link --- src/hssm/link.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/hssm/link.py b/src/hssm/link.py index 9eea10d5..1ad00c10 100644 --- a/src/hssm/link.py +++ b/src/hssm/link.py @@ -20,22 +20,24 @@ class Link(bmb.Link): Parameters ---------- - name : str + name The name of the link function. If it is a known name, it's not necessary to pass any other arguments because functions are already defined internally. If not known, all of `link``, ``linkinv`` and ``linkinv_backend`` must be specified. - link : function + link : optional A function that maps the response to the linear predictor. Known as the :math:`g` function in GLM jargon. Does not need to be specified when ``name`` is a known name. - linkinv : function + linkinv : optional A function that maps the linear predictor to the response. Known as the :math:`g^{-1}` function in GLM jargon. Does not need to be specified when ``name`` is a known name. - linkinv_backend : function + linkinv_backend : optional Same than ``linkinv`` but must be something that works with PyMC backend (i.e. it must work with PyTensor tensors). Does not need to be specified when ``name`` is a known name. + bounds : optional + Bounds of the response scale. Only needed when ``name`` is ``gen_logit``. """ def __init__(